NXOpen::CAE::SimConditionSequence Class Reference

This class represents a time history of CAE::SimCondition . More...

Inheritance diagram for NXOpen::CAE::SimConditionSequence:

Public Types
enum	OutOfRangeBehavior { OutOfRangeBehaviorClip, OutOfRangeBehaviorExtrapolate }
	Specifies behavior of CAE::SimConditionSequence::GetValue when time is out of range. More...

Public Member Functions
NXOpen::CAE::SimConditionTimeStepCollection *	ConditionTimeStepCollection ()
	Returns the CAE::SimConditionTimeStepCollection .
void	Evaluate (double time)
	Evaluate all CAE::SimConditionParam related expressions at a given time.
void	Evaluate (double time, bool update)
	Convenience overloaded method provided to control if an update will be requested after CAE::SimConditionSequence has been evaluated.
std::vector< NXString >	GetDescription ()
	Returns the condition sequence description.
NXOpen::Unit *	GetTimeUnits ()
	Returns the time units for the whole sequence.
double	GetValue (NXOpen::CAE::SimConditionParam *param, double time)
	Returns the interpolated value of a CAE::SimConditionParam at the specified time.
double	GetValue (NXOpen::CAE::SimConditionParam *param, double time, NXOpen::CAE::SimConditionSequence::OutOfRangeBehavior behavior)
	Returns the interpolated value of a CAE::SimConditionParam at the specified time.
void	SetDescription (std::vector< NXString > &description)
	Sets the condition sequence description Created in NX9.0.0.
void	SetTimeUnits (NXOpen::Unit *units)
	Sets the time units for the whole sequence Created in NX9.0.0.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class represents a time history of CAE::SimCondition .

An instance of this class can be obtained from CAE::SimConditionSeqMgr .

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::SimConditionSequence::OutOfRangeBehavior

Specifies behavior of CAE::SimConditionSequence::GetValue when time is out of range.

Enumerator:

OutOfRangeBehaviorClip	clip
OutOfRangeBehaviorExtrapolate	extrapolate

Member Function Documentation

NXOpen::CAE::SimConditionTimeStepCollection* NXOpen::CAE::SimConditionSequence::ConditionTimeStepCollection

(

)

Returns the CAE::SimConditionTimeStepCollection .

Created in NX9.0.0.

void NXOpen::CAE::SimConditionSequence::Evaluate

(

double

time

)

Evaluate all CAE::SimConditionParam related expressions at a given time.

Will update the expressions. Time units are the ones defined by CAE::SimConditionSequence::SetTimeUnits .
Created in NX9.0.0.

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

Parameters

time

time

void NXOpen::CAE::SimConditionSequence::Evaluate	(	double	time,
		bool	update
	)

Convenience overloaded method provided to control if an update will be requested after CAE::SimConditionSequence has been evaluated.

Created in NX9.0.0.

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

Parameters

time	time
update	update

std::vector<NXString> NXOpen::CAE::SimConditionSequence::GetDescription

(

)

Returns the condition sequence description.

Returns

the description
Created in NX9.0.0.

License requirements : None

NXOpen::Unit* NXOpen::CAE::SimConditionSequence::GetTimeUnits

(

)

Returns the time units for the whole sequence.

Returns

the units value
Created in NX9.0.0.

License requirements : None

double NXOpen::CAE::SimConditionSequence::GetValue	(	NXOpen::CAE::SimConditionParam *	param,
		double	time
	)

Returns the interpolated value of a CAE::SimConditionParam at the specified time.

Same units as specified CAE::SimConditionParam . Will error out if specified time value is out of range.

Returns

Created in NX9.0.0.

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

Parameters

param	param
time	time

double NXOpen::CAE::SimConditionSequence::GetValue	(	NXOpen::CAE::SimConditionParam *	param,
		double	time,
		NXOpen::CAE::SimConditionSequence::OutOfRangeBehavior	behavior
	)

Returns the interpolated value of a CAE::SimConditionParam at the specified time.

Same units as specified CAE::SimConditionParam . Will behave as specified in CAE::SimConditionSequence::OutOfRangeBehavior .

Returns

Created in NX9.0.0.

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

Parameters

param	param
time	time
behavior	behavior

void NXOpen::CAE::SimConditionSequence::SetDescription

(

std::vector< NXString > &

description

)

Sets the condition sequence description
Created in NX9.0.0.

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

Parameters

description

NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAE::SimConditionSequence::SetTimeUnits

(

NXOpen::Unit *

units

)

Sets the time units for the whole sequence
Created in NX9.0.0.

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

Parameters

units

units

---

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

• CAE_SimConditionSequence.hxx