NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::PostScenarioBuilderSlot Class Reference

This class represents a NXOpen::CAE::PostScenarioBuilderSlot . More...

Inheritance diagram for NXOpen::CAE::PostScenarioBuilderSlot:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::CAE::DataSourceDataSource ()
 Returns the selected CAE::DataSource
Created in NX12.0.0. More...
 
std::vector
< NXOpen::CAE::DataSource * > 
GetAvailableDataSources ()
 List CAE::DataSource applicable to the current slot. More...
 
std::vector
< NXOpen::CAE::PostScenarioDefinition * > 
GetAvailableDefinitionsForDataSource (NXOpen::CAE::DataSource *dataSource)
 List NXOpen::CAE::PostScenarioDefinition applicable to the current slot for a particular CAE::DataSource . More...
 
std::vector
< NXOpen::CAE::PostScenarioDefinition * > 
GetDefinitions ()
 Returns the selected CAE::PostScenarioDefinition. More...
 
NXString Name ()
 Returns the name of the input definition slot. More...
 
void SetDataSource (NXOpen::CAE::DataSource *dataSource, NXOpen::CAE::PostScenarioDefinition *dataDefinition)
 Assign data to this slot. More...
 
void SetDataSource (NXOpen::CAE::DataSource *dataSource, const std::vector< NXOpen::CAE::PostScenarioDefinition * > &dataDefinitions)
 Assign data to this slot. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class represents a NXOpen::CAE::PostScenarioBuilderSlot .

A NXOpen::CAE::PostScenarioBuilder can contain multiple slots to which NXOpen::CAE::DataSource s and respective NXOpen::CAE::PostScenarioDefinition s are assigned. The scenario retrieves data from these data sources in order to process it and display it via NXOpen::CAE::PostScenarioBuilder::Visualization .


No support for KF.

Created in NX12.0.0.

Member Function Documentation

NXOpen::CAE::DataSource* NXOpen::CAE::PostScenarioBuilderSlot::DataSource ( )

Returns the selected CAE::DataSource
Created in NX12.0.0.



License requirements : None

std::vector<NXOpen::CAE::DataSource *> NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources ( )

List CAE::DataSource applicable to the current slot.

Data Sources are retrieved from NXOpen::CAE::PostScenarioManager::DataSources and filtered to only contain data applicable to the current scenario slot.

Returns

Created in NX12.0.0.

License requirements : None
std::vector<NXOpen::CAE::PostScenarioDefinition *> NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource ( NXOpen::CAE::DataSource dataSource)

List NXOpen::CAE::PostScenarioDefinition applicable to the current slot for a particular CAE::DataSource .

This is a utility method. The

dataSource

parameter should have been retrieved via NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources .

Returns

Created in NX12.0.0.

License requirements : None
Parameters
dataSourcedatasource
std::vector<NXOpen::CAE::PostScenarioDefinition *> NXOpen::CAE::PostScenarioBuilderSlot::GetDefinitions ( )

Returns the selected CAE::PostScenarioDefinition.

Returns

Created in NX12.0.0.

License requirements : None
NXString NXOpen::CAE::PostScenarioBuilderSlot::Name ( )

Returns the name of the input definition slot.


Created in NX12.0.0.

License requirements : None

void NXOpen::CAE::PostScenarioBuilderSlot::SetDataSource ( NXOpen::CAE::DataSource dataSource,
NXOpen::CAE::PostScenarioDefinition dataDefinition 
)

Assign data to this slot.

This assignment applies to the owning NXOpen::CAE::PostScenarioBuilder . The NXOpen::CAE::DataSource and NXOpen::CAE::PostScenarioDataDefinition have to be consistent and relevant to this scenario. See NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources and NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource . This overload should be used for data assignments.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
dataSourceshould be retrieved through NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources .
dataDefinitionShould be retrieved by calling NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource with the
dataSource
parameter.
void NXOpen::CAE::PostScenarioBuilderSlot::SetDataSource ( NXOpen::CAE::DataSource dataSource,
const std::vector< NXOpen::CAE::PostScenarioDefinition * > &  dataDefinitions 
)

Assign data to this slot.

This assignment applies to the owning NXOpen::CAE::PostScenarioBuilder . The NXOpen::CAE::DataSource and NXOpen::CAE::PostScenarioDefinition have to be consistent and relevant to this scenario. See NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources and NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource . This overload should be used for FE Model assignments.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
dataSourceshould be retrieved through NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDataSources .
dataDefinitionsShould be retrieved by calling NXOpen::CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource with the
dataSource
parameter.

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.