NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  IterationOption { All, None }
 Specifies behavior of CAE.PostScenarioVariable.SetIterationValues . More...
 

Public Member Functions

unsafe void AssignBooleanValues (bool[] values)
 Assign boolean values to this Selection Variable. More...
 
unsafe void AssignComplexValues (NXOpen.CAE.Complex[] values)
 Assign complex values to this Selection Variable. More...
 
unsafe void AssignDoubleValues (double[] values)
 Assign double values to this Selection Variable. More...
 
unsafe void AssignIntegerValues (int[] values)
 Assign integer values to this Selection Variable. More...
 
unsafe void AssignStringValues (string[] values)
 Assign string values to this Selection Variable. More...
 
unsafe void AssignUnicodeStringValues (string[] values)
 Assign unicode string values to this Selection Variable. More...
 
unsafe void AssignValues (NXOpen.CAE.PostScenarioVariant[] values)
 Assign variant values to this Selection Variable. More...
 
unsafe
NXOpen.CAE.PostScenarioVariant[] 
GetValues ()
 Read the available values of this variable. More...
 
unsafe void SetIterationValues (NXOpen.CAE.PostScenarioVariable.IterationOption behavior)
 Assign iteration values to this CAE.PostScenarioVariable . More...
 
unsafe void SetIterationValues (NXOpen.CAE.PostScenarioVariant[] values)
 Assign iteration values to this CAE.PostScenarioVariable . More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string DisplayName [get]
 Returns the localized name of this Variable. More...
 
unsafe string Name [get]
 Returns the name of this Variable. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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
All 

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

None 

Set no iteration values for this variable.

Member Function Documentation

unsafe void NXOpen.CAE.PostScenarioVariable.AssignBooleanValues ( bool[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignComplexValues ( NXOpen.CAE.Complex[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignDoubleValues ( double[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignIntegerValues ( int[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignStringValues ( string[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignUnicodeStringValues ( string[]  values)
inline

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
values
unsafe void NXOpen.CAE.PostScenarioVariable.AssignValues ( NXOpen.CAE.PostScenarioVariant[]  values)
inline

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
values
unsafe NXOpen.CAE.PostScenarioVariant [] NXOpen.CAE.PostScenarioVariable.GetValues ( )
inline

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")

Returns
unsafe void NXOpen.CAE.PostScenarioVariable.SetIterationValues ( NXOpen.CAE.PostScenarioVariable.IterationOption  behavior)
inline

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
behavior
unsafe void NXOpen.CAE.PostScenarioVariable.SetIterationValues ( NXOpen.CAE.PostScenarioVariant[]  values)
inline

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
values

Property Documentation

unsafe string NXOpen.CAE.PostScenarioVariable.DisplayName
get

Returns the localized name of this Variable.

Created in NX11.0.0

License requirements: None.

unsafe string NXOpen.CAE.PostScenarioVariable.Name
get

Returns the name of this Variable.

Created in NX11.0.0

License requirements: None.


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