SimConditionSequence Class¶
-
class
NXOpen.CAE.
SimConditionSequence
¶ Bases:
NXOpen.TaggedObject
This class represents a time history of
NXOpen.CAE.SimCondition
.An instance of this class can be obtained from
NXOpen.CAE.SimConditionSeqMgr
.New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
Tag | Returns the Tag for this object. |
ConditionTimeStepCollection | Returns the NXOpen.CAE.SimConditionTimeStepCollection . |
Methods¶
Method | Description |
---|---|
Evaluate | Evaluate all NXOpen.CAE.SimConditionParam related expressions at a given time. |
GetDescription | Returns the condition sequence description |
GetTimeUnits | Returns the time units for the whole sequence |
GetValue | Returns the interpolated value of a NXOpen.CAE.SimConditionParam at the specified time. |
SetDescription | Sets the condition sequence description |
SetTimeUnits | Sets the time units for the whole sequence |
Enumerations¶
SimConditionSequenceOutOfRangeBehavior Enumeration | Specifies behavior of NXOpen.CAE.SimConditionSequence.GetValue() when time is out of range. |
ConditionTimeStepCollection¶
-
SimConditionSequence.
ConditionTimeStepCollection
¶ Returns the
NXOpen.CAE.SimConditionTimeStepCollection
.Signature
ConditionTimeStepCollection
New in version NX9.0.0.
Returns: Return type: NXOpen.CAE.SimConditionTimeStepCollection
Method Detail¶
Evaluate¶
-
SimConditionSequence.
Evaluate
¶ Overloaded method Evaluate
Evaluate(time)
Evaluate(time, update)
-------------------------------------
Evaluate all
NXOpen.CAE.SimConditionParam
related expressions at a given time. Will update the expressions. Time units are the ones defined byNXOpen.CAE.SimConditionSequence.SetTimeUnits()
.Signature
Evaluate(time)
Parameters: time (float) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Convenience overloaded method provided to control if an update will be requested after
NXOpen.CAE.SimConditionSequence
has been evaluated.Signature
Evaluate(time, update)
Parameters: - time (float) –
- update (bool) –
New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
GetDescription¶
-
SimConditionSequence.
GetDescription
¶ Returns the condition sequence description
Signature
GetDescription()
Returns: the description Return type: list of str New in version NX9.0.0.
License requirements: None.
GetTimeUnits¶
-
SimConditionSequence.
GetTimeUnits
¶ Returns the time units for the whole sequence
Signature
GetTimeUnits()
Returns: the units value Return type: NXOpen.Unit
New in version NX9.0.0.
License requirements: None.
GetValue¶
-
SimConditionSequence.
GetValue
¶ Overloaded method GetValue
GetValue(param, time)
GetValue(param, time, behavior)
-------------------------------------
Returns the interpolated value of a
NXOpen.CAE.SimConditionParam
at the specified time. Same units as specifiedNXOpen.CAE.SimConditionParam
. Will error out if specified time value is out of range.Signature
GetValue(param, time)
Parameters: - param (
NXOpen.CAE.SimConditionParam
) – - time (float) –
Returns: Return type: float
New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Returns the interpolated value of a
NXOpen.CAE.SimConditionParam
at the specified time. Same units as specifiedNXOpen.CAE.SimConditionParam
. Will behave as specified inNXOpen.CAE.SimConditionSequenceOutOfRangeBehavior
.Signature
GetValue(param, time, behavior)
Parameters: - param (
NXOpen.CAE.SimConditionParam
) – - time (float) –
- behavior (
NXOpen.CAE.SimConditionSequenceOutOfRangeBehavior
) –
Returns: Return type: float
New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
SetDescription¶
-
SimConditionSequence.
SetDescription
¶ Sets the condition sequence description
Signature
SetDescription(description)
Parameters: description (list of str) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetTimeUnits¶
-
SimConditionSequence.
SetTimeUnits
¶ Sets the time units for the whole sequence
Signature
SetTimeUnits(units)
Parameters: units ( NXOpen.Unit
) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)