A dynamically typed scalar value. More...

Inheritance diagram for NXOpen::CAE::PostScenarioVariant:

Public Member Functions
NXOpen::CAE::PostScenarioVariantType	GetDataType ()
	Read the type. More...

bool	GetValueAsBoolean ()
	Read the typed value. More...

NXOpen::CAE::Complex	GetValueAsComplex ()
	Read the typed value. More...

NXOpen::CAE::PostScenarioVariantComponent	GetValueAsComponent ()
	Read the typed value. More...

double	GetValueAsDouble ()
	Read the typed value. More...

int	GetValueAsInteger ()
	Read the typed value. More...

NXOpen::CAE::PostScenarioModeDescription	GetValueAsModeDescription ()
	Read the typed value. More...

NXString	GetValueAsString ()
	Read the typed value. More...

NXString	GetValueAsUnicodeString ()
	Read the typed value. More...

NXOpen::Vector3d	GetValueAsVector3d ()
	Read the typed value. More...

void	SetValueAsBoolean (bool value)
	Set a typed value. More...

void	SetValueAsComplex (const NXOpen::CAE::Complex &value)
	Set a typed value. More...

void	SetValueAsComponent (NXOpen::CAE::PostScenarioVariantComponent value)
	Set a typed value. More...

void	SetValueAsDouble (double value)
	Set a typed value. More...

void	SetValueAsInteger (int value)
	Set a typed value. More...

void	SetValueAsModeDescription (const NXOpen::CAE::PostScenarioModeDescription &value)
	Set a typed value. More...

void	SetValueAsString (const NXString &value)
	Set a typed value. More...

void	SetValueAsString (const char *value)
	Set a typed value. More...

void	SetValueAsUnary ()
	Set a typed value. More...

void	SetValueAsUnicodeString (const NXString &value)
	Set a typed value. More...

void	SetValueAsUnicodeString (const char *value)
	Set a typed value. More...

void	SetValueAsVector3d (const NXOpen::Vector3d &value)
	Set a typed value. More...

virtual	~PostScenarioVariant ()
	Dispose of this instance. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	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.

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostScenarioVariant::~PostScenarioVariant ( )

virtual

Dispose of this instance.

Created in NX11.0.0.

License requirements : None

Member Function Documentation

NXOpen::CAE::PostScenarioVariantType NXOpen::CAE::PostScenarioVariant::GetDataType ( )

Read the type.

Returns: Created in NX11.0.0.

License requirements : None

bool NXOpen::CAE::PostScenarioVariant::GetValueAsBoolean ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

NXOpen::CAE::Complex NXOpen::CAE::PostScenarioVariant::GetValueAsComplex ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

NXOpen::CAE::PostScenarioVariantComponent NXOpen::CAE::PostScenarioVariant::GetValueAsComponent ( )

Read the typed value.

Returns: Created in NX12.0.0.

License requirements : None

double NXOpen::CAE::PostScenarioVariant::GetValueAsDouble ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

int NXOpen::CAE::PostScenarioVariant::GetValueAsInteger ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

NXOpen::CAE::PostScenarioModeDescription NXOpen::CAE::PostScenarioVariant::GetValueAsModeDescription ( )

Read the typed value.

Returns: Created in NX12.0.0.

License requirements : None

NXString NXOpen::CAE::PostScenarioVariant::GetValueAsString ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

NXString NXOpen::CAE::PostScenarioVariant::GetValueAsUnicodeString ( )

Read the typed value.

Returns: Created in NX11.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::CAE::PostScenarioVariant::GetValueAsVector3d ( )

Read the typed value.

Returns: Created in NX12.0.0.

License requirements : None

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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsComplex ( const 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 value

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 value

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 value

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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsModeDescription ( const 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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsString ( const NXString & 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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsString ( const char * 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 value

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

void NXOpen::CAE::PostScenarioVariant::SetValueAsUnicodeString ( const NXString & 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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsUnicodeString ( const char * 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 value

void NXOpen::CAE::PostScenarioVariant::SetValueAsVector3d ( const 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 value

The documentation for this class was generated from the following file:

CAE_PostScenarioVariant.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation