NXOpen.CAE.SimConditionSequence Class Reference

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

Inheritance diagram for NXOpen.CAE.SimConditionSequence:

Public Types
enum	OutOfRangeBehavior { Clip, Extrapolate }
	Specifies behavior of NXOpen.CAE.SimConditionSequence.GetValue when time is out of range. More...

Public Member Functions
unsafe void	Evaluate (double time)
	Evaluate all NXOpen.CAE.SimConditionParam related expressions at a given time. More...
unsafe void	Evaluate (double time, bool update)
	Convenience overloaded method provided to control if an update will be requested after NXOpen.CAE.SimConditionSequence has been evaluated. More...
unsafe string[]	GetDescription ()
	Returns the condition sequence description More...
unsafe NXOpen.Unit	GetTimeUnits ()
	Returns the time units for the whole sequence More...
unsafe double	GetValue (NXOpen.CAE.SimConditionParam param, double time)
	Returns the interpolated value of a NXOpen.CAE.SimConditionParam at the specified time. More...
unsafe double	GetValue (NXOpen.CAE.SimConditionParam param, double time, NXOpen.CAE.SimConditionSequence.OutOfRangeBehavior behavior)
	Returns the interpolated value of a NXOpen.CAE.SimConditionParam at the specified time. More...
unsafe void	SetDescription (string[] description)
	Sets the condition sequence description More...
unsafe void	SetTimeUnits (NXOpen.Unit units)
	Sets the time units for the whole sequence 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
NXOpen.CAE.SimConditionTimeStepCollection	ConditionTimeStepCollection [get]
	Returns the NXOpen.CAE.SimConditionTimeStepCollection . 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

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

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

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.CAE.SimConditionSequence.OutOfRangeBehavior

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

Enumerator
Clip
Extrapolate

Member Function Documentation

unsafe void NXOpen.CAE.SimConditionSequence.Evaluate ( double  time )

inline

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

Will update the expressions. Time units are the ones defined by NXOpen.CAE.SimConditionSequence.SetTimeUnits .

Created in NX9.0.0

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

Parameters

time

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

inline

Convenience overloaded method provided to control if an update will be requested after NXOpen.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
update

unsafe string [] NXOpen.CAE.SimConditionSequence.GetDescription ( )

inline

Returns the condition sequence description

Created in NX9.0.0

License requirements: None.

Returns

the description

unsafe NXOpen.Unit NXOpen.CAE.SimConditionSequence.GetTimeUnits ( )

inline

Returns the time units for the whole sequence

Created in NX9.0.0

License requirements: None.

Returns

the units value

unsafe double NXOpen.CAE.SimConditionSequence.GetValue ( NXOpen.CAE.SimConditionParam  param, double  time  )

inline

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

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

Created in NX9.0.0

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

Parameters

param
time

Returns

unsafe double NXOpen.CAE.SimConditionSequence.GetValue ( NXOpen.CAE.SimConditionParam  param, double  time, NXOpen.CAE.SimConditionSequence.OutOfRangeBehavior  behavior  )

inline

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

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

Created in NX9.0.0

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

Parameters

param
time
behavior

Returns

unsafe void NXOpen.CAE.SimConditionSequence.SetDescription ( string[]  description )

inline

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

unsafe void NXOpen.CAE.SimConditionSequence.SetTimeUnits ( NXOpen.Unit  units )

inline

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

Property Documentation

NXOpen.CAE.SimConditionTimeStepCollection NXOpen.CAE.SimConditionSequence.ConditionTimeStepCollection

get

Returns the NXOpen.CAE.SimConditionTimeStepCollection .

Created in NX9.0.0

---

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

• CAE_SimConditionSequence.cs