SimCondition Class — NXOpen Python API Reference 12.0.0 documentation

# SimCondition Class

class `NXOpen.CAE.``SimCondition`

  Bases: `NXOpen.TaggedObject`

  This class represents a Condition which defines a state where all or some values of `NXOpen.CAE.SimConditionParam` are known.

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

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
Label | Returns the condition’s label.
Name | Returns or sets the condition’s name
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetValue | Returns the condition specified parameter value.
IsValueDefined | Returns if the condition specified parameter value is defined.
SetValue | Sets the condition specified parameter value.

# Property Detail

## Label

`SimCondition.``Label`

  Returns the condition’s label.

  Label is unique and greater than zero. It can only be set at creation of a condition and cannot be changed. The label is the key used to locate a specific condition.

  `-------------------------------------`

  Getter Method

  Signature `Label`

  Returns: | the label value
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

## Name

`SimCondition.``Name`

  Returns or sets the condition’s name

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: | the name value
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX9.0.0.

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

# Method Detail

## GetValue

`SimCondition.``GetValue`

  Returns the condition specified parameter value.

  Use the parameter’s object as a key in for the value. Errors out if parameter doesn’t exist. Errors out if value is undefined. Same units as specified `NXOpen.CAE.SimConditionParam`.

  Signature `GetValue(param)`

  Parameters: | param (`NXOpen.CAE.SimConditionParam`) –
  Returns: | the condition parameter value
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

## IsValueDefined

`SimCondition.``IsValueDefined`

  Returns if the condition specified parameter value is defined.

  Use the parameter’s object as a key in. Errors out if parameter doesn’t exist.

  Signature `IsValueDefined(param)`

  Parameters: | param (`NXOpen.CAE.SimConditionParam`) –
  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

## SetValue

`SimCondition.``SetValue`

  Sets the condition specified parameter value.

  Use the parameter’s object as a key in for the value. Errors out if parameter doesn’t exist. Same units as specified `NXOpen.CAE.SimConditionParam`.

  Signature `SetValue(param, value)`

  Parameters:

  - param (`NXOpen.CAE.SimConditionParam`) –
  - value (float) –

  New in version NX9.0.0.

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