PrlResultsEvaluationSettingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PrlResultsEvaluationSettingBuilder Class

class `NXOpen.CAE.ResponseSimulation.``PrlResultsEvaluationSettingBuilder`

  Bases: `NXOpen.CAE.ResponseSimulation.DynamicResultEvaluationSettingBuilder`

  Represents the abstract builder class of evaluation setting for peak value, RMS results and LCR results.

  This is an abstract class, and cannot be created.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
CoordinateSystem | Returns or sets the coordinate system.
ObservationNode | Returns or sets the relative node.
Relative | Returns or sets the option of using the observation node in evaluation
ResultType | Returns or sets the result type
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.
GetDataComponents | Returns the direction data components.
GetDescriptionString | Returns the description.
GetObject | Returns the object currently being edited by this builder.
GetOutputElements | Returns the destination elements.
GetOutputNodes | Returns the destination nodes.
SetDataComponents | Sets the direction data components.
SetDescriptionString | Sets the description
SetOutputElements | Sets the destination elements
SetOutputNodes | Sets the destination nodes
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.

# Property Detail

## CoordinateSystem

`PrlResultsEvaluationSettingBuilder.``CoordinateSystem`

  Returns or sets the coordinate system.

  Only available when the result type is `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Stress`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.ShellResultant`

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

  Getter Method

  Signature `CoordinateSystem`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.CoordinateSystem`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `CoordinateSystem`

  Parameters: | coordinateSystem (`NXOpen.CAE.ResponseSimulation.CoordinateSystem`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ObservationNode

`PrlResultsEvaluationSettingBuilder.``ObservationNode`

  Returns or sets the relative node.

  Only available when result type is `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Displacement`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Acceleration`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.ElementForce`

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

  Getter Method

  Signature `ObservationNode`

  Returns: |
  Return type: | `NXOpen.CAE.FENode`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ObservationNode`

  Parameters: | relativeNode (`NXOpen.CAE.FENode`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## Relative

`PrlResultsEvaluationSettingBuilder.``Relative`

  Returns or sets the option of using the observation node in evaluation

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

  Getter Method

  Signature `Relative`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Relative`

  Parameters: | relative (bool) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ResultType

`PrlResultsEvaluationSettingBuilder.``ResultType`

  Returns or sets the result type

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

  Getter Method

  Signature `ResultType`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.EvaluationResultType`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ResultType`

  Parameters: | resultType (`NXOpen.CAE.ResponseSimulation.EvaluationResultType`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

# Method Detail

## GetDataComponents

`PrlResultsEvaluationSettingBuilder.``GetDataComponents`

  Returns the direction data components.

  The condidate choices will be changed according to `NXOpen.CAE.ResponseSimulation.EvaluationResultType` setting

  Signature `GetDataComponents()`

  Returns: |
  Return type: | list of `NXOpen.CAE.ResponseSimulation.DirectionDataComponent`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## GetOutputElements

`PrlResultsEvaluationSettingBuilder.``GetOutputElements`

  Returns the destination elements.

  Only available when the result type is `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Stress`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.ShellResultant`

  Signature `GetOutputElements()`

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

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## GetOutputNodes

`PrlResultsEvaluationSettingBuilder.``GetOutputNodes`

  Returns the destination nodes.

  Only available when result type is `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Displacement`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.Acceleration`, `NXOpen.CAE.ResponseSimulation.EvaluationResultType.ElementForce`

  Signature `GetOutputNodes()`

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

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SetDataComponents

`PrlResultsEvaluationSettingBuilder.``SetDataComponents`

  Sets the direction data components.

  The condidate choices will be changed according to `NXOpen.CAE.ResponseSimulation.EvaluationResultType` setting

  Signature `SetDataComponents(dataComponent)`

  Parameters: | dataComponent (list of `NXOpen.CAE.ResponseSimulation.DirectionDataComponent`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SetOutputElements

`PrlResultsEvaluationSettingBuilder.``SetOutputElements`

  Sets the destination elements

  Signature `SetOutputElements(destinationElements)`

  Parameters: | destinationElements (list of `NXOpen.CAE.FEElement`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SetOutputNodes

`PrlResultsEvaluationSettingBuilder.``SetOutputNodes`

  Sets the destination nodes

  Signature `SetOutputNodes(destinationNodes)`

  Parameters: | destinationNodes (list of `NXOpen.CAE.FENode`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## Validate

`PrlResultsEvaluationSettingBuilder.``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.