NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::CAE::PostScenarioManager Class Reference

Manages the creation of a NXOpen::CAE::PostScenarioBuilder . More...

Public Member Functions

void AlignAxesOfPlots ()
 Aligns axes of all plots. More...
 
NXOpen::CAE::PostScenarioAvailableDescriptorCollectionAvailablePostScenarioDescriptors ()
 Contains a NXOpen::CAE::PostScenarioAvailableDescriptorCollection . More...
 
bool CheckScenarioDataSourceCompatible (NXOpen::CAE::PostScenarioParameters *scenarioParameters)
 Checks if the scenario and the data source set in the NXOpen::CAE::PostScenarioParameters are compatible. More...
 
bool CheckValidDataSource (NXOpen::CAE::PostScenarioParameters *scenarioParameters)
 Checks if the data source set in NXOpen::CAE::PostScenarioParameters is valid. More...
 
NXOpen::CAE::PostScenarioBuilderCreatePostScenarioBuilderFromParameters (NXOpen::CAE::PostScenarioParameters *scenarioParameters)
 Creates a transient object NXOpen::CAE::PostScenarioBuilder that is responsible for creating a post scenario object. More...
 
NXOpen::CAE::PostScenarioBuilderCreatePostScenarioBuilderFromScenario (NXOpen::CAE::PostScenario *scenario)
 Creates a builder for the Scenario retrieved from a Visualized Scenario. More...
 
NXOpen::CAE::PostScenarioBuilderCreatePostScenarioBuilderFromViewport (int viewportIndex)
 Creates a builder for the Scenario retrieved from a Visualized Scenario from a certain viewport. More...
 
NXOpen::CAE::ViewportSynchronizationOptionsCreateViewportSynchronizationOptions ()
 Creates viewport synchronization options. More...
 
NXOpen::CAE::DataSourceCollectionDataSources ()
 Contains a NXOpen::CAE::DataSourceCollection . More...
 
std::vector
< NXOpen::CAE::PostScenario * > 
GetScenariosInViewport (int viewportIndex)
 Retrieves the scenarios plotted in viewportIndex. More...
 
NXOpen::CAE::PostScenarioVisualizationCustomizationCollectionGetVisualizationCustomizationCollection (int viewPortId)
 Returns customization data for all visualizations (which support customization) in the specified viewPortId. More...
 
NXOpen::CAE::PostScenarioParametersNewPostScenarioParameters ()
 Creates a transient object NXOpen::CAE::PostScenarioParameters that contains the settings required to create a post scenario. More...
 
NXOpen::CAE::PostScenarioDescriptorCollectionPostScenarioDescriptors ()
 Contains a NXOpen::CAE::PostScenarioDescriptorCollection . More...
 
void RemoveScenario (NXOpen::CAE::PostScenario *scenario)
 Removes a visualized NXOpen::CAE::PostScenario from the viewport it is displayed in. More...
 
void SetViewportSynchronizationOptions (NXOpen::CAE::ViewportSynchronizationOptions *options)
 Sets the viewport synchronization options. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Manages the creation of a NXOpen::CAE::PostScenarioBuilder .


To obtain an instance of this class use NXOpen::CAE::PostScenarioManager .

Created in NX11.0.0.

Member Function Documentation

void NXOpen::CAE::PostScenarioManager::AlignAxesOfPlots ( )

Aligns axes of all plots.

Ensures that all axes of a certain quantity (force, displacement, etc.) and data type (real, imaginary, magnitude, etc.) have the same unit, axis type and limits.
Created in NX1847.0.0.

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

NXOpen::CAE::PostScenarioAvailableDescriptorCollection* NXOpen::CAE::PostScenarioManager::AvailablePostScenarioDescriptors ( )

Contains a NXOpen::CAE::PostScenarioAvailableDescriptorCollection .

This member enumerates scenario descriptors available for use with the Data Sources selected in NXOpen::CAE::PostScenarioManager::DataSources .


Created in NX12.0.0.

bool NXOpen::CAE::PostScenarioManager::CheckScenarioDataSourceCompatible ( NXOpen::CAE::PostScenarioParameters scenarioParameters)

Checks if the scenario and the data source set in the NXOpen::CAE::PostScenarioParameters are compatible.


Deprecated:
Deprecated in NX12.0.0. This function is no longer useful because the new API only lists compatible data sources per slot.


Created in NX11.0.0.

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

Parameters
scenarioParametersscenarioparameters
bool NXOpen::CAE::PostScenarioManager::CheckValidDataSource ( NXOpen::CAE::PostScenarioParameters scenarioParameters)

Checks if the data source set in NXOpen::CAE::PostScenarioParameters is valid.


Created in NX11.0.0.

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

Parameters
scenarioParametersscenarioparameters
NXOpen::CAE::PostScenarioBuilder* NXOpen::CAE::PostScenarioManager::CreatePostScenarioBuilderFromParameters ( NXOpen::CAE::PostScenarioParameters scenarioParameters)

Creates a transient object NXOpen::CAE::PostScenarioBuilder that is responsible for creating a post scenario object.


Created in NX11.0.0.

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

Parameters
scenarioParametersscenarioparameters
NXOpen::CAE::PostScenarioBuilder* NXOpen::CAE::PostScenarioManager::CreatePostScenarioBuilderFromScenario ( NXOpen::CAE::PostScenario scenario)

Creates a builder for the Scenario retrieved from a Visualized Scenario.


Created in NX12.0.0.

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

Parameters
scenarioscenario
NXOpen::CAE::PostScenarioBuilder* NXOpen::CAE::PostScenarioManager::CreatePostScenarioBuilderFromViewport ( int  viewportIndex)

Creates a builder for the Scenario retrieved from a Visualized Scenario from a certain viewport.

This method fails if the specified viewport does not represent a Visualized Scenario.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::PostScenarioManager::CreatePostScenarioBuilderFromScenario instead. Scenarios can be retrieved via NXOpen::CAE::PostScenarioManager::GetScenariosInViewport .


Created in NX11.0.0.

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

Parameters
viewportIndexviewportindex
NXOpen::CAE::ViewportSynchronizationOptions* NXOpen::CAE::PostScenarioManager::CreateViewportSynchronizationOptions ( )

Creates viewport synchronization options.

These options synchronize selections and probes across the selected viewports.


Created in NX12.0.0.

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

NXOpen::CAE::DataSourceCollection* NXOpen::CAE::PostScenarioManager::DataSources ( )

Contains a NXOpen::CAE::DataSourceCollection .

The NXOpen::CAE::DataSource s added to this collection will be used to populate the NXOpen::CAE::PostScenarioManager::AvailablePostScenarioDescriptors . These data sources will also be the ones available to any NXOpen::CAE::PostScenarioBuilder in the current session.
Created in NX12.0.0.

std::vector<NXOpen::CAE::PostScenario *> NXOpen::CAE::PostScenarioManager::GetScenariosInViewport ( int  viewportIndex)

Retrieves the scenarios plotted in viewportIndex.


Created in NX1847.0.0.

License requirements : None

Parameters
viewportIndexviewportindex
NXOpen::CAE::PostScenarioVisualizationCustomizationCollection* NXOpen::CAE::PostScenarioManager::GetVisualizationCustomizationCollection ( int  viewPortId)

Returns customization data for all visualizations (which support customization) in the specified viewPortId.


Created in NX1847.0.0.

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

Parameters
viewPortIdviewportid
NXOpen::CAE::PostScenarioParameters* NXOpen::CAE::PostScenarioManager::NewPostScenarioParameters ( )

Creates a transient object NXOpen::CAE::PostScenarioParameters that contains the settings required to create a post scenario.

The object should be destroyed after the post scenario is created.
Created in NX11.0.0.

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

NXOpen::CAE::PostScenarioDescriptorCollection* NXOpen::CAE::PostScenarioManager::PostScenarioDescriptors ( )
void NXOpen::CAE::PostScenarioManager::RemoveScenario ( NXOpen::CAE::PostScenario scenario)

Removes a visualized NXOpen::CAE::PostScenario from the viewport it is displayed in.

The corresponding plots will be removed from the display. If there are other scenarios visualized in that viewport, their corresponding plots will continue to be visible. If there are no more scenarios displayed in that viewport, the viewport is returned to the model view.
Created in NX1847.0.0.

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

Parameters
scenarioscenario
void NXOpen::CAE::PostScenarioManager::SetViewportSynchronizationOptions ( NXOpen::CAE::ViewportSynchronizationOptions options)

Sets the viewport synchronization options.

These options synchronize selections and probes across the selected viewports. Passing NULL will disable all synchronizations.


Created in NX12.0.0.

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

Parameters
optionsoptions
tag_t NXOpen::CAE::PostScenarioManager::Tag ( ) const

Returns the tag of this object.


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