PostScenarioVariable Class — NXOpen Python API Reference 12.0.0 documentation

# PostScenarioVariable Class

class `NXOpen.CAE.``PostScenarioVariable`

  Bases: `NXOpen.TaggedObject`

  A selection variable to which values can be bound in order to define a user selection for a post scenario. See `NXOpen.CAE.PostScenarioSelectionParameters`

  Not support KF.

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
DisplayName | Returns the localized name of this Variable.
Name | Returns the name of this Variable.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AssignBooleanValues | Assign boolean values to this Selection Variable.
AssignComplexValues | Assign complex values to this Selection Variable.
AssignDoubleValues | Assign double values to this Selection Variable.
AssignIntegerValues | Assign integer values to this Selection Variable.
AssignStringValues | Assign string values to this Selection Variable.
AssignUnicodeStringValues | Assign unicode string values to this Selection Variable.
AssignValues | Assign variant values to this Selection Variable.
GetValues | Read the available values of this variable.

# Property Detail

## DisplayName

`PostScenarioVariable.``DisplayName`

  Returns the localized name of this Variable.

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

  Getter Method

  Signature `DisplayName`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

## Name

`PostScenarioVariable.``Name`

  Returns the name of this Variable.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## AssignBooleanValues

`PostScenarioVariable.``AssignBooleanValues`

  Assign boolean values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignBooleanValues(values)`

  Parameters: | values (list of bool) –

  New in version NX11.0.0.

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

## AssignComplexValues

`PostScenarioVariable.``AssignComplexValues`

  Assign complex values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignComplexValues(values)`

  Parameters: | values (list of `NXOpen.CAE.Complex`) –

  New in version NX11.0.0.

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

## AssignDoubleValues

`PostScenarioVariable.``AssignDoubleValues`

  Assign double values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignDoubleValues(values)`

  Parameters: | values (list of float) –

  New in version NX11.0.0.

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

## AssignIntegerValues

`PostScenarioVariable.``AssignIntegerValues`

  Assign integer values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignIntegerValues(values)`

  Parameters: | values (list of int) –

  New in version NX11.0.0.

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

## AssignStringValues

`PostScenarioVariable.``AssignStringValues`

  Assign string values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignStringValues(values)`

  Parameters: | values (list of str) –

  New in version NX11.0.0.

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

## AssignUnicodeStringValues

`PostScenarioVariable.``AssignUnicodeStringValues`

  Assign unicode string values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignUnicodeStringValues(values)`

  Parameters: | values (list of str) –

  New in version NX11.0.0.

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

## AssignValues

`PostScenarioVariable.``AssignValues`

  Assign variant values to this Selection Variable.

  The assigned values must be a subset of the values returned by GetValues, otherwise an exception is raised.

  Signature `AssignValues(values)`

  Parameters: | values (list of `NXOpen.CAE.PostScenarioVariant`) –

  New in version NX11.0.0.

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

## GetValues

`PostScenarioVariable.``GetValues`

  Read the available values of this variable.

  The returned values have to be disposed explicitely. This returns all the possible values which can be assigned to this PostScenarioVariable.

  Signature `GetValues()`

  Returns: |
  Return type: | list of `NXOpen.CAE.PostScenarioVariant`

  New in version NX11.0.0.

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