ModelUpdateSensitivityViewerBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ModelUpdateSensitivityViewerBuilder Class

class `NXOpen.CAE.``ModelUpdateSensitivityViewerBuilder`

  Bases: `NXOpen.Builder`

  Represents `NXOpen.CAE.ModelUpdateSensitivityViewerBuilder`

  To create a new instance of this class, use `NXOpen.CAE.ModelUpdateSolutionCollection.CreateSensitivityViewerBuilder()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetDesignVariableLabels | Gets the design variable labels
GetObject | Returns the object currently being edited by this builder.
GetSensitivityValues | Gets the sensitivity values
GetTargetIds | Gets the target IDs
SetDesignVariableLabels | Sets the design variable labels
SetSensitivityValues | Sets the sensitivity values
SetTargetIds | Sets the terget IDs
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## GetDesignVariableLabels

`ModelUpdateSensitivityViewerBuilder.``GetDesignVariableLabels`

  Gets the design variable labels

  Signature `GetDesignVariableLabels()`

  Returns: | SM allocated array containing the design variable labels
  Return type: | list of str

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## GetSensitivityValues

`ModelUpdateSensitivityViewerBuilder.``GetSensitivityValues`

  Gets the sensitivity values

  Signature `GetSensitivityValues()`

  Returns: | SM allocated array containing the sensitivity values
  Return type: | list of float

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## GetTargetIds

`ModelUpdateSensitivityViewerBuilder.``GetTargetIds`

  Gets the target IDs

  Signature `GetTargetIds()`

  Returns: | SM allocated array containing the targets ID
  Return type: | list of int

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## SetDesignVariableLabels

`ModelUpdateSensitivityViewerBuilder.``SetDesignVariableLabels`

  Sets the design variable labels

  Signature `SetDesignVariableLabels(designVaraibleLabels)`

  Parameters: | designVaraibleLabels (list of str) – The design variable labels

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## SetSensitivityValues

`ModelUpdateSensitivityViewerBuilder.``SetSensitivityValues`

  Sets the sensitivity values

  Signature `SetSensitivityValues(sensitivityValues)`

  Parameters: | sensitivityValues (list of float) – The sensitivity values

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## SetTargetIds

`ModelUpdateSensitivityViewerBuilder.``SetTargetIds`

  Sets the terget IDs

  Signature `SetTargetIds(targetIds)`

  Parameters: | targetIds (list of int) – The target IDs

  New in version NX6.0.0.

  License requirements: nx_correl_update (“FE Model Update”)

## Validate

`ModelUpdateSensitivityViewerBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.