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

The class represents the NXOpen::CAE::PostScenarioParameters used to instanciate a NXOpen::CAE::PostScenarioBuilder . More...

Inheritance diagram for NXOpen::CAE::PostScenarioParameters:
NXOpen::TransientObject

Public Member Functions

NXOpen::CAE::IPostScenarioDataSourceDataSource ()
 Returns the data source object to be processed by the post scenario. More...
 
NXOpen::CAE::PostScenarioDescriptorScenarioDescriptor ()
 Returns the scenario descriptor used by the post scenario. More...
 
void SetDataSource (NXOpen::CAE::IPostScenarioDataSource *dataSource)
 Sets the data source object to be processed by the post scenario. More...
 
void SetPreferredDataSources (const std::vector< NXOpen::CAE::DataSource * > &dataSources)
 Set preferred Data Sources to influence the default configuration of a scenario. More...
 
void SetScenarioDescriptor (NXOpen::CAE::PostScenarioDescriptor *scenarioDesc)
 Sets the scenario descriptor used by the post scenario. More...
 
void SetViewPortIndex (int viewPortIndex)
 Sets the index of a view port on the main graphic window, on which the plot graph will be shown. More...
 
int ViewPortIndex ()
 Returns the index of a view port on the main graphic window, on which the plot graph will be shown. More...
 
virtual ~PostScenarioParameters ()
 Destroys the object
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

The class represents the NXOpen::CAE::PostScenarioParameters used to instanciate a NXOpen::CAE::PostScenarioBuilder .


To create a new instance of this class, use NXOpen::CAE::PostScenarioManager::NewPostScenarioParameters

Created in NX11.0.0.

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostScenarioParameters::~PostScenarioParameters ( )
virtual

Destroys the object
Created in NX11.0.0.



License requirements : None

Member Function Documentation

NXOpen::CAE::IPostScenarioDataSource* NXOpen::CAE::PostScenarioParameters::DataSource ( )

Returns the data source object to be processed by the post scenario.


Deprecated:
Deprecated in NX12.0.0. Data Sources are now added through CAE::PostScenarioManager::DataSources . Alternatively, CAE::PostScenarioParameters::SetPreferredDataSources can be used to configure the default configuration of a scenario. Setting this attribute has the same effect as SetPreferredDataSources(value).


Created in NX11.0.0.

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

NXOpen::CAE::PostScenarioDescriptor* NXOpen::CAE::PostScenarioParameters::ScenarioDescriptor ( )

Returns the scenario descriptor used by the post scenario.


Created in NX11.0.0.

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

void NXOpen::CAE::PostScenarioParameters::SetDataSource ( NXOpen::CAE::IPostScenarioDataSource dataSource)

Sets the data source object to be processed by the post scenario.


Deprecated:
Deprecated in NX12.0.0. Data Sources are now added through CAE::PostScenarioManager::DataSources . Alternatively, CAE::PostScenarioParameters::SetPreferredDataSources can be used to configure the default configuration of a scenario. Setting this attribute has the same effect as SetPreferredDataSources(value).


Created in NX11.0.0.

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

Parameters
dataSourcedatasource
void NXOpen::CAE::PostScenarioParameters::SetPreferredDataSources ( const std::vector< NXOpen::CAE::DataSource * > &  dataSources)

Set preferred Data Sources to influence the default configuration of a scenario.

If the default configuration of a scenario is known to be overridden later in the program, there is no need to call this method. Setting a single preferred data source enables the behaviour from version 11.0.0.


Created in NX12.0.0.

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

Parameters
dataSourcesThe data sources can be retrieved from CAE::PostScenarioManager::DataSources
void NXOpen::CAE::PostScenarioParameters::SetScenarioDescriptor ( NXOpen::CAE::PostScenarioDescriptor scenarioDesc)

Sets the scenario descriptor used by the post scenario.


Created in NX11.0.0.

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

Parameters
scenarioDescscenariodesc
void NXOpen::CAE::PostScenarioParameters::SetViewPortIndex ( int  viewPortIndex)

Sets the index of a view port on the main graphic window, on which the plot graph will be shown.


Created in NX11.0.0.

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

Parameters
viewPortIndexviewportindex
int NXOpen::CAE::PostScenarioParameters::ViewPortIndex ( )

Returns the index of a view port on the main graphic window, on which the plot graph will be shown.


Created in NX11.0.0.

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


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