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

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

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

Public Member Functions

bool CheckSelectionParameters (NXOpen::CAE::PostScenarioSelectionParameters *parameters)
 Check the validity of a NXOpen::CAE::PostScenarioSelectionParameters before using it. More...
 
NXOpen::CAE::PostScenarioDataDefinitionDataDefinition ()
 Returns the selected NXOpen::CAE::PostScenarioDataDefinition . More...
 
NXOpen::CAE::PostScenarioBuilderDataDefinitionCollectionDataDefinitions ()
 Access available Data Source Data Definitions. More...
 
std::vector
< NXOpen::CAE::PostScenarioDataDefinition * > 
GetAvailableDataDefinitions ()
 List NXOpen::CAE::PostScenarioDataDefinition s available for the selected NXOpen::CAE::PostScenarioInputDefinition . More...
 
std::vector
< NXOpen::CAE::PostScenarioInputDefinition * > 
GetAvailableInputDefinitions ()
 List NXOpen::CAE::PostScenarioInputDefinition applicable to the currently selected NXOpen::CAE::PostScenarioDataDefinition . More...
 
std::vector
< NXOpen::CAE::PostScenarioVisualizationDefinition * > 
GetAvailableVisualizationDefinitions ()
 List NXOpen::CAE::PostScenarioVisualizationDefinition s available for the selected NXOpen::CAE::PostScenarioInputDefinition and NXOpen::CAE::PostScenarioDataDefinition . More...
 
NXOpen::CAE::PostScenarioInputDefinitionInputDefinition ()
 Returns the selected NXOpen::CAE::PostScenarioInputDefinition . More...
 
NXOpen::CAE::PostScenarioSelectionParametersNewPostScenarioSelectionParameters ()
 Create a new instance of NXOpen::CAE::PostScenarioSelectionParameters . More...
 
void SetDataDefinition (NXOpen::CAE::PostScenarioDataDefinition *dataDefinition)
 Sets the selected NXOpen::CAE::PostScenarioDataDefinition . More...
 
void SetInputDefinition (NXOpen::CAE::PostScenarioInputDefinition *inputDefinition)
 Sets the selected NXOpen::CAE::PostScenarioInputDefinition . More...
 
void SetSelectionParameters (NXOpen::CAE::PostScenarioSelectionParameters *parameters)
 Set the NXOpen::CAE::PostScenarioSelectionParameters . More...
 
void SetViewportIndex (int viewportIndex)
 Set the viewport index for the NXOpen::CAE::PostScenarioBuilder . More...
 
void SetVisualization (NXOpen::CAE::PostScenarioVisualizationDefinition *visualization)
 Sets the selected NXOpen::CAE::PostScenarioVisualizationDefinition . More...
 
NXOpen::CAE::PostScenarioBuilderSlotCollectionSlots ()
 Access the data slots available to the currently selected NXOpen::CAE::PostScenarioDescriptor . More...
 
NXOpen::CAE::PostScenarioVisualizationDefinitionVisualization ()
 Returns the selected NXOpen::CAE::PostScenarioVisualizationDefinition . 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::PostScenarioBuilder .


No support for KF.

Created in NX11.0.0.

Member Function Documentation

bool NXOpen::CAE::PostScenarioBuilder::CheckSelectionParameters ( NXOpen::CAE::PostScenarioSelectionParameters parameters)

Check the validity of a NXOpen::CAE::PostScenarioSelectionParameters before using it.

Returns

Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
parametersparameters
NXOpen::CAE::PostScenarioDataDefinition* NXOpen::CAE::PostScenarioBuilder::DataDefinition ( )

Returns the selected NXOpen::CAE::PostScenarioDataDefinition .


Deprecated:
Deprecated in NX12.0.0. Use CAE::PostScenarioBuilderSlot::GetDefinitions and CAE::PostScenarioBuilderSlot::DataSource instead.


Created in NX11.0.0.

License requirements : None

NXOpen::CAE::PostScenarioBuilderDataDefinitionCollection* NXOpen::CAE::PostScenarioBuilder::DataDefinitions ( )

Access available Data Source Data Definitions.

A data definition defines the format of some data exposed by a data source. These are matched with a scenario Input Definition to provide a scenario interpreted view of that data.


Deprecated:
Deprecated in NX12.0.0. Use CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource or CAE::DataSource::GetDefinitions instead.


Created in NX11.0.0.

std::vector<NXOpen::CAE::PostScenarioDataDefinition *> NXOpen::CAE::PostScenarioBuilder::GetAvailableDataDefinitions ( )

List NXOpen::CAE::PostScenarioDataDefinition s available for the selected NXOpen::CAE::PostScenarioInputDefinition .

Returns

Deprecated:
Deprecated in NX12.0.0. Use CAE::PostScenarioBuilderSlot::GetAvailableDefinitionsForDataSource instead.


Created in NX11.0.0.

License requirements : None

std::vector<NXOpen::CAE::PostScenarioInputDefinition *> NXOpen::CAE::PostScenarioBuilder::GetAvailableInputDefinitions ( )

List NXOpen::CAE::PostScenarioInputDefinition applicable to the currently selected NXOpen::CAE::PostScenarioDataDefinition .

Returns

Created in NX11.0.0.

License requirements : None
std::vector<NXOpen::CAE::PostScenarioVisualizationDefinition *> NXOpen::CAE::PostScenarioBuilder::GetAvailableVisualizationDefinitions ( )

List NXOpen::CAE::PostScenarioVisualizationDefinition s available for the selected NXOpen::CAE::PostScenarioInputDefinition and NXOpen::CAE::PostScenarioDataDefinition .

Returns

Created in NX11.0.0.

License requirements : None
NXOpen::CAE::PostScenarioInputDefinition* NXOpen::CAE::PostScenarioBuilder::InputDefinition ( )

Returns the selected NXOpen::CAE::PostScenarioInputDefinition .


Created in NX11.0.0.

License requirements : None

NXOpen::CAE::PostScenarioSelectionParameters* NXOpen::CAE::PostScenarioBuilder::NewPostScenarioSelectionParameters ( )

Create a new instance of NXOpen::CAE::PostScenarioSelectionParameters .

Returns

Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
void NXOpen::CAE::PostScenarioBuilder::SetDataDefinition ( NXOpen::CAE::PostScenarioDataDefinition dataDefinition)

Sets the selected NXOpen::CAE::PostScenarioDataDefinition .


Deprecated:
Deprecated in NX12.0.0. Use CAE::PostScenarioBuilderSlot::SetDataSource instead.


Created in NX11.0.0.

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

Parameters
dataDefinitiondatadefinition
void NXOpen::CAE::PostScenarioBuilder::SetInputDefinition ( NXOpen::CAE::PostScenarioInputDefinition inputDefinition)

Sets the selected NXOpen::CAE::PostScenarioInputDefinition .


Created in NX11.0.0.

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

Parameters
inputDefinitioninputdefinition
void NXOpen::CAE::PostScenarioBuilder::SetSelectionParameters ( NXOpen::CAE::PostScenarioSelectionParameters parameters)

Set the NXOpen::CAE::PostScenarioSelectionParameters .


Created in NX11.0.0.

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

Parameters
parametersparameters
void NXOpen::CAE::PostScenarioBuilder::SetViewportIndex ( int  viewportIndex)

Set the viewport index for the NXOpen::CAE::PostScenarioBuilder .


Created in NX12.0.0.

License requirements : None

Parameters
viewportIndexviewportindex
void NXOpen::CAE::PostScenarioBuilder::SetVisualization ( NXOpen::CAE::PostScenarioVisualizationDefinition visualization)

Sets the selected NXOpen::CAE::PostScenarioVisualizationDefinition .


Created in NX11.0.0.

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

Parameters
visualizationvisualization
NXOpen::CAE::PostScenarioBuilderSlotCollection* NXOpen::CAE::PostScenarioBuilder::Slots ( )

Access the data slots available to the currently selected NXOpen::CAE::PostScenarioDescriptor .

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


Created in NX12.0.0.

NXOpen::CAE::PostScenarioVisualizationDefinition* NXOpen::CAE::PostScenarioBuilder::Visualization ( )

Returns the selected NXOpen::CAE::PostScenarioVisualizationDefinition .


Created in NX11.0.0.

License requirements : None


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