TransientResultsReductionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TransientResultsReductionBuilder Class

class `NXOpen.CAE.``TransientResultsReductionBuilder`

  Bases: `NXOpen.CAE.ResultsManipulationBuilder`

  Represents a `NXOpen.CAE.TransientResultsReductionBuilder`

  To obtain an instance of this class use `NXOpen.Session.ResultManager()`.

  New in version NX8.5.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.
GetObject | Returns the object currently being edited by this builder.
SetAction | The action
SetAppendMethod | The append method if action is `NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult`
SetCompanionResultName | The companion result name if action is `NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult`
SetCompanionResultReference | The companion Result Reference if action is `NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult`
SetCompanionSolution | The companion solution if action is `NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult`
SetCreateSolution | Specifies whether to create an imported solution
SetEvaluationErrorOption | Set evaluation error option
SetFormula | The formula
SetImportResult | Import the result immediately
SetImportedSolutionName | The imported solution name if action is `NXOpen.CAE.ResultsManipulationBuilderAction.CreateImportedSolution`
SetIncludeModel | Include nodes and elements
SetIncompatibleResultsOption | Set incompatible results option
SetLastIteration | The last iteration
SetLoadcaseName | The load case name
SetNoDataOption | Set no data option
SetOutputFile | The output file
SetOutputName | The output name
SetOutputQuantity | The output quantity
SetOutputResultType | The result output type
SetResult | The result types
SetUnitsSystem | The units system
SetUnitsSystemResult | The result to copy the units system from
SetUserDefinedUnitsSystem | The user-defined units system
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.

# Enumerations

TransientResultsReductionBuilderEvaluationError Enumeration | evaluation error options
TransientResultsReductionBuilderIncompatibleResults Enumeration | Incompatible results options
TransientResultsReductionBuilderNoData Enumeration | No data options

# Method Detail

## SetEvaluationErrorOption

`TransientResultsReductionBuilder.``SetEvaluationErrorOption`

  Set evaluation error option

  Signature `SetEvaluationErrorOption(evaluationErrorOption)`

  Parameters: | evaluationErrorOption (`NXOpen.CAE.TransientResultsReductionBuilderEvaluationError`) –

  New in version NX8.5.0.

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

## SetFormula

`TransientResultsReductionBuilder.``SetFormula`

  The formula

  Signature `SetFormula(formula)`

  Parameters: | formula (str) – set formula

  New in version NX8.5.0.

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

## SetIncompatibleResultsOption

`TransientResultsReductionBuilder.``SetIncompatibleResultsOption`

  Set incompatible results option

  Signature `SetIncompatibleResultsOption(incompatibleResultsOption)`

  Parameters: | incompatibleResultsOption (`NXOpen.CAE.TransientResultsReductionBuilderIncompatibleResults`) –

  New in version NX8.5.0.

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

## SetLastIteration

`TransientResultsReductionBuilder.``SetLastIteration`

  The last iteration

  Signature `SetLastIteration(iteration)`

  Parameters: | iteration (`NXOpen.CAE.BaseIteration`) – set last iteration

  New in version NX8.5.0.

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

## SetNoDataOption

`TransientResultsReductionBuilder.``SetNoDataOption`

  Set no data option

  Signature `SetNoDataOption(noDataOption)`

  Parameters: | noDataOption (`NXOpen.CAE.TransientResultsReductionBuilderNoData`) –

  New in version NX8.5.0.

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

## SetResult

`TransientResultsReductionBuilder.``SetResult`

  The result types

  Signature `SetResult(result, parameters, names)`

  Parameters:

  - result (`NXOpen.CAE.Result`) – set result
  - parameters (list of `NXOpen.CAE.ResultParameters`) – set result parameters
  - names (list of str) – set result names

  New in version NX8.5.0.

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

## Validate

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