NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | List of all members
NXOpen.CAE.PostScenarioVariant Class Reference

A dynamically typed scalar value. More...

Inheritance diagram for NXOpen.CAE.PostScenarioVariant:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe
NXOpen.CAE.PostScenarioVariantType 
GetDataType ()
 Read the type. More...
 
unsafe bool GetValueAsBoolean ()
 Read the typed value. More...
 
unsafe NXOpen.CAE.Complex GetValueAsComplex ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioVariantComponent 
GetValueAsComponent ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioCoordinateSystem 
GetValueAsCoordinateSystem ()
 Read the typed value. More...
 
unsafe double GetValueAsDouble ()
 Read the typed value. More...
 
unsafe int GetValueAsInteger ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioModeDescription 
GetValueAsModeDescription ()
 Read the typed value. More...
 
unsafe string GetValueAsString ()
 Read the typed value. More...
 
unsafe string GetValueAsUnicodeString ()
 Read the typed value. More...
 
unsafe NXOpen.Vector3d GetValueAsVector3d ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioCoordinateSystem 
NewPostScenarioCoordinateSystem (NXOpen.CAE.PostScenarioCoordinateSystemType type, NXOpen.Vector3d origin, NXOpen.Matrix3x3 matrix)
 Create a new Post Scenario Coordinate System ((NXOpen.CAE.PostScenarioCoordinateSystem )). More...
 
unsafe void SetValueAsBoolean (bool value)
 Set a typed value. More...
 
unsafe void SetValueAsComplex (NXOpen.CAE.Complex value)
 Set a typed value. More...
 
unsafe void SetValueAsComponent (NXOpen.CAE.PostScenarioVariantComponent value)
 Set a typed value. More...
 
unsafe void SetValueAsCoordinateSystem (NXOpen.CAE.PostScenarioCoordinateSystem value)
 Set a typed value. More...
 
unsafe void SetValueAsDouble (double value)
 Set a typed value. More...
 
unsafe void SetValueAsInteger (int value)
 Set a typed value. More...
 
unsafe void SetValueAsModeDescription (NXOpen.CAE.PostScenarioModeDescription value)
 Set a typed value. More...
 
unsafe void SetValueAsString (string value)
 Set a typed value. More...
 
unsafe void SetValueAsUnary ()
 Set a typed value. More...
 
unsafe void SetValueAsUnicodeString (string value)
 Set a typed value. More...
 
unsafe void SetValueAsVector3d (NXOpen.Vector3d value)
 Set a typed value. More...
 
unsafe void SetValueAsWildcard ()
 Set a typed value. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Dispose of this instance. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

A dynamically typed scalar value.

A Variant is a scalar value whose type is determined at runtime based on the previously assigned value. For example, once an integer number is assigned to a variant, that Variant now represents an integer. Variants are needed to read and assign values in a generic way, and it permits arbitrary PostScenarios (NXOpen.CAE.PostScenarioBuilder ) and arbitrary Data Sources to work together to provide a seamless post processing experience. Variant instances need to be disposed of after they are no longer needed.

To create a new instance of this class, use NXOpen.CAE.PostScenarioSelectionParameters.NewVariant

Created in NX11.0.0

Member Function Documentation

override void NXOpen.CAE.PostScenarioVariant.FreeResource ( )
inlineprotectedvirtual

Dispose of this instance.

Created in NX11.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe NXOpen.CAE.PostScenarioVariantType NXOpen.CAE.PostScenarioVariant.GetDataType ( )
inline

Read the type.

Created in NX11.0.0

License requirements: None.

Returns
unsafe bool NXOpen.CAE.PostScenarioVariant.GetValueAsBoolean ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.Complex NXOpen.CAE.PostScenarioVariant.GetValueAsComplex ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioVariantComponent NXOpen.CAE.PostScenarioVariant.GetValueAsComponent ( )
inline

Read the typed value.

Created in NX12.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioCoordinateSystem NXOpen.CAE.PostScenarioVariant.GetValueAsCoordinateSystem ( )
inline

Read the typed value.

Created in NX1847.0.0

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

Returns
unsafe double NXOpen.CAE.PostScenarioVariant.GetValueAsDouble ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe int NXOpen.CAE.PostScenarioVariant.GetValueAsInteger ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioModeDescription NXOpen.CAE.PostScenarioVariant.GetValueAsModeDescription ( )
inline

Read the typed value.

Created in NX12.0.0

License requirements: None.

Returns
unsafe string NXOpen.CAE.PostScenarioVariant.GetValueAsString ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe string NXOpen.CAE.PostScenarioVariant.GetValueAsUnicodeString ( )
inline

Read the typed value.

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.Vector3d NXOpen.CAE.PostScenarioVariant.GetValueAsVector3d ( )
inline

Read the typed value.

Created in NX12.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioCoordinateSystem NXOpen.CAE.PostScenarioVariant.NewPostScenarioCoordinateSystem ( NXOpen.CAE.PostScenarioCoordinateSystemType  type,
NXOpen.Vector3d  origin,
NXOpen.Matrix3x3  matrix 
)
inline

Create a new Post Scenario Coordinate System ((NXOpen.CAE.PostScenarioCoordinateSystem )).

Created in NX1847.0.0

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

Parameters
type
origin
matrix
Returns
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsBoolean ( bool  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsComplex ( NXOpen.CAE.Complex  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsComponent ( NXOpen.CAE.PostScenarioVariantComponent  value)
inline

Set a typed value.

Created in NX12.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsCoordinateSystem ( NXOpen.CAE.PostScenarioCoordinateSystem  value)
inline

Set a typed value.

Created in NX1847.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsDouble ( double  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsInteger ( int  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsModeDescription ( NXOpen.CAE.PostScenarioModeDescription  value)
inline

Set a typed value.

Created in NX12.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsString ( string  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsUnary ( )
inline

Set a typed value.

This method is parameterless because the void types does not have values.

Created in NX12.0.0

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

unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsUnicodeString ( string  value)
inline

Set a typed value.

Created in NX11.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsVector3d ( NXOpen.Vector3d  value)
inline

Set a typed value.

Created in NX12.0.0

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

Parameters
value
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsWildcard ( )
inline

Set a typed value.

This method is parameterless because the void types does not have values.

Created in NX1847.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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.