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

A selection variable to which values can be bound in order to define a user selection for a post scenario. More...

Inheritance diagram for NXOpen::CAE::PostScenarioVariable:
NXOpen::TaggedObject

Public Types

enum  IterationOption { IterationOptionAll, IterationOptionNone }
 Specifies behavior of CAE::PostScenarioVariable::SetIterationValues . More...
 

Public Member Functions

void AssignBooleanValues (const std::vector< bool > &values)
 Assign boolean values to this Selection Variable. More...
 
void AssignComplexValues (const std::vector< NXOpen::CAE::Complex > &values)
 Assign complex values to this Selection Variable. More...
 
void AssignDoubleValues (const std::vector< double > &values)
 Assign double values to this Selection Variable. More...
 
void AssignIntegerValues (const std::vector< int > &values)
 Assign integer values to this Selection Variable. More...
 
void AssignStringValues (std::vector< NXString > &values)
 Assign string values to this Selection Variable. More...
 
void AssignUnicodeStringValues (std::vector< NXString > &values)
 Assign unicode string values to this Selection Variable. More...
 
void AssignValues (const std::vector< NXOpen::CAE::PostScenarioVariant * > &values)
 Assign variant values to this Selection Variable. More...
 
NXString DisplayName ()
 Returns the localized name of this Variable. More...
 
std::vector
< NXOpen::CAE::PostScenarioVariant * > 
GetValues ()
 Read the available values of this variable. More...
 
NXString Name ()
 Returns the name of this Variable. More...
 
void SetIterationValues (NXOpen::CAE::PostScenarioVariable::IterationOption behavior)
 Assign iteration values to this CAE::PostScenarioVariable . More...
 
void SetIterationValues (const std::vector< NXOpen::CAE::PostScenarioVariant * > &values)
 Assign iteration values to this CAE::PostScenarioVariable . More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

A selection variable to which values can be bound in order to define a user selection for a post scenario.

See NXOpen::CAE::PostScenarioSelectionParameters


Not support KF.

Created in NX11.0.0.

Member Enumeration Documentation

Specifies behavior of CAE::PostScenarioVariable::SetIterationValues .

Enumerator
IterationOptionAll 

Set all values returned by CAE::PostScenarioVariable::GetValues as iteration values.

IterationOptionNone 

Set no iteration values for this variable.

Member Function Documentation

void NXOpen::CAE::PostScenarioVariable::AssignBooleanValues ( const std::vector< bool > &  values)

Assign boolean values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignComplexValues ( const std::vector< NXOpen::CAE::Complex > &  values)

Assign complex values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignDoubleValues ( const std::vector< double > &  values)

Assign double values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignIntegerValues ( const std::vector< int > &  values)

Assign integer values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignStringValues ( std::vector< NXString > &  values)

Assign string values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignUnicodeStringValues ( std::vector< NXString > &  values)

Assign unicode string values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
void NXOpen::CAE::PostScenarioVariable::AssignValues ( const std::vector< NXOpen::CAE::PostScenarioVariant * > &  values)

Assign variant values to this Selection Variable.

The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.


Created in NX11.0.0.

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

Parameters
valuesvalues
NXString NXOpen::CAE::PostScenarioVariable::DisplayName ( )

Returns the localized name of this Variable.


Created in NX11.0.0.

License requirements : None

std::vector<NXOpen::CAE::PostScenarioVariant *> NXOpen::CAE::PostScenarioVariable::GetValues ( )

Read the available values of this variable.

The returned values have to be disposed explicitely. This returns all the possible values which can be assigned to this PostScenarioVariable.


Created in NX11.0.0.

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

NXString NXOpen::CAE::PostScenarioVariable::Name ( )

Returns the name of this Variable.


Created in NX11.0.0.

License requirements : None

void NXOpen::CAE::PostScenarioVariable::SetIterationValues ( NXOpen::CAE::PostScenarioVariable::IterationOption  behavior)

Assign iteration values to this CAE::PostScenarioVariable .

Iteration values enable navigation in contour plot view. The assigned values must be a subset of the values returned by CAE::PostScenarioVariable::GetValues .


Created in NX1847.0.0.

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

Parameters
behaviorbehavior
void NXOpen::CAE::PostScenarioVariable::SetIterationValues ( const std::vector< NXOpen::CAE::PostScenarioVariant * > &  values)

Assign iteration values to this CAE::PostScenarioVariable .

Iteration values enable navigation in contour plot view. The assigned values must be a subset of the values returned by CAE::PostScenarioVariable::GetValues .


Created in NX1847.0.0.

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

Parameters
valuesvalues

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