NXOpen .NET Reference  12.0.0
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:

Public Member Functions

unsafe bool GetValueAsBoolean ()
 Read the typed value. More...
 
unsafe int GetValueAsInteger ()
 Read the typed value. More...
 
unsafe double GetValueAsDouble ()
 Read the typed value. More...
 
unsafe NXOpen.CAE.Complex GetValueAsComplex ()
 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.PostScenarioVariantComponent 
GetValueAsComponent ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioModeDescription 
GetValueAsModeDescription ()
 Read the typed value. More...
 
unsafe
NXOpen.CAE.PostScenarioVariantType 
GetDataType ()
 Read the type. More...
 
unsafe void SetValueAsBoolean (bool value)
 Set a typed value. More...
 
unsafe void SetValueAsInteger (int value)
 Set a typed value. More...
 
unsafe void SetValueAsDouble (double value)
 Set a typed value. More...
 
unsafe void SetValueAsComplex (NXOpen.CAE.Complex value)
 Set a typed value. More...
 
unsafe void SetValueAsString (string value)
 Set a typed value. More...
 
unsafe void SetValueAsUnicodeString (string value)
 Set a typed value. More...
 
unsafe void SetValueAsUnary ()
 Set a typed value. More...
 
unsafe void SetValueAsVector3d (NXOpen.Vector3d value)
 Set a typed value. More...
 
unsafe void SetValueAsComponent (NXOpen.CAE.PostScenarioVariantComponent value)
 Set a typed value. More...
 
unsafe void SetValueAsModeDescription (NXOpen.CAE.PostScenarioModeDescription value)
 Set a typed value. More...
 

Protected Member Functions

override void FreeResource ()
 Dispose of this instance. 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 ( )
protected

Dispose of this instance.

Created in NX11.0.0

License requirements: None.

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

Read the type.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX12.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX12.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX11.0.0

License requirements: None.

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

Read the typed value.

Created in NX12.0.0

License requirements: None.

Returns
unsafe void NXOpen.CAE.PostScenarioVariant.SetValueAsBoolean ( bool  value)

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)

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)

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.SetValueAsDouble ( double  value)

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)

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)

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)

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

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)

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)

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

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