ResultsReductionBuilder Class

class NXOpen.CAE.ResultsReductionBuilder

Bases: NXOpen.CAE.ResultsManipulationBuilder

Represents a NXOpen.CAE.ResultsReductionBuilder

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
SetDependentDomain Set Dependent Domain
SetDependentDomainName Set Dependent Domain Name
SetElementValueAtNode Set element value to be used at a node
SetEvaluationErrorOption Set evaluation error option
SetFieldName Set field Name to be created
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
SetIndependentDomain Set Independent Domain
SetIndependentDomainName Set Independent Domain Name
SetLoadcaseName The load case name
SetNoDataOption Set no data option
SetOutput Set output type from result reduction
SetOutputFile The output file
SetOutputName The output name
SetOutputQuantity The output quantity
SetOutputResultType The result output type
SetResultTypeName Set result type name that will be displayed in postview
SetResultUnit Set result unit for given result type/dependent field variable type
SetResults The result types
SetUnitsSystem The units system
SetUnitsSystemResult The result to copy the units system from
SetUserDefinedUnitsSystem The user-defined units system
SetViewIndexForPostView Set view index where postview will be created
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

SetDependentDomain

ResultsReductionBuilder.SetDependentDomain

Set Dependent Domain

Signature SetDependentDomain(domain)

Parameters:domain (NXOpen.Fields.FieldDomain) – Dependent Domain

New in version NX9.0.0.

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

SetDependentDomainName

ResultsReductionBuilder.SetDependentDomainName

Set Dependent Domain Name

Signature SetDependentDomainName(domainName)

Parameters:domainName (str) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.ResultsReductionBuilder.SetDependentDomain() instead.

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

SetElementValueAtNode

ResultsReductionBuilder.SetElementValueAtNode

Set element value to be used at a node

Signature SetElementValueAtNode(value)

Parameters:value (NXOpen.CAE.ResultsManipulationBuilderElementValueAtNode) –

New in version NX9.0.0.

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

SetEvaluationErrorOption

ResultsReductionBuilder.SetEvaluationErrorOption

Set evaluation error option

Signature SetEvaluationErrorOption(evaluationErrorOption)

Parameters:evaluationErrorOption (NXOpen.CAE.ResultsReductionBuilderEvaluationError) –

New in version NX8.5.0.

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

SetFieldName

ResultsReductionBuilder.SetFieldName

Set field Name to be created

Signature SetFieldName(fieldName)

Parameters:fieldName (str) –

New in version NX9.0.0.

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

SetFormula

ResultsReductionBuilder.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

ResultsReductionBuilder.SetIncompatibleResultsOption

Set incompatible results option

Signature SetIncompatibleResultsOption(incompatibleResultsOption)

Parameters:incompatibleResultsOption (NXOpen.CAE.ResultsReductionBuilderIncompatibleResults) –

New in version NX8.5.0.

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

SetIndependentDomain

ResultsReductionBuilder.SetIndependentDomain

Set Independent Domain

Signature SetIndependentDomain(domain)

Parameters:domain (NXOpen.Fields.FieldDomain) – Independent Domain

New in version NX9.0.0.

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

SetIndependentDomainName

ResultsReductionBuilder.SetIndependentDomainName

Set Independent Domain Name

Signature SetIndependentDomainName(domainName)

Parameters:domainName (str) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.ResultsReductionBuilder.SetIndependentDomain() instead.

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

SetNoDataOption

ResultsReductionBuilder.SetNoDataOption

Set no data option

Signature SetNoDataOption(noDataOption)

Parameters:noDataOption (NXOpen.CAE.ResultsReductionBuilderNoData) –

New in version NX8.5.0.

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

SetOutput

ResultsReductionBuilder.SetOutput

Set output type from result reduction

Signature SetOutput(output)

Parameters:output (NXOpen.CAE.ResultsReductionBuilderOutput) –

New in version NX9.0.0.

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

SetResultTypeName

ResultsReductionBuilder.SetResultTypeName

Set result type name that will be displayed in postview

Signature SetResultTypeName(resultTypeName)

Parameters:resultTypeName (str) –

New in version NX9.0.0.

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

SetResultUnit

ResultsReductionBuilder.SetResultUnit

Set result unit for given result type/dependent field variable type

Signature SetResultUnit(unit)

Parameters:unit (NXOpen.Unit) –

New in version NX9.0.0.

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

SetResults

ResultsReductionBuilder.SetResults

The result types

Signature SetResults(results, parameters, names)

Parameters:

New in version NX8.5.0.

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

SetViewIndexForPostView

ResultsReductionBuilder.SetViewIndexForPostView

Set view index where postview will be created

Signature SetViewIndexForPostView(viewIndex)

Parameters:viewIndex (int) –

New in version NX9.0.0.

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

Validate

ResultsReductionBuilder.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.