ResultsManipulationBuilder Class

class NXOpen.CAE.ResultsManipulationBuilder

Bases: NXOpen.Builder

Represents an abstract NXOpen.CAE.ResultsManipulationBuilder

This is an abstract class and cannot be instantiated

New in version NX7.5.2.

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
SetImportResult Import the result immediately
SetImportedSolutionName The imported solution name if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateImportedSolution
SetIncludeModel Include nodes and elements
SetLoadcaseName The load case name
SetOutputFile The output file
SetOutputName The output name
SetOutputQuantity The output quantity
SetOutputResultType The result output type
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.

Method Detail

SetAction

ResultsManipulationBuilder.SetAction

The action

Signature SetAction(action)

Parameters:action (NXOpen.CAE.ResultsManipulationBuilderAction) – set action

New in version NX7.5.2.

Deprecated since version NX9.0.0: Use NXOpen.CAE.ResultsManipulationBuilder.SetOutputResultType() instead.

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

SetAppendMethod

ResultsManipulationBuilder.SetAppendMethod

The append method if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult

Signature SetAppendMethod(appendMethod)

Parameters:appendMethod (NXOpen.CAE.ResultsManipulationBuilderResultAppendMethod) – set append method

New in version NX8.5.0.

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

SetCompanionResultName

ResultsManipulationBuilder.SetCompanionResultName

The companion result name if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult

Signature SetCompanionResultName(companionResultName)

Parameters:companionResultName (str) – set companion result name

New in version NX8.5.0.

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

SetCompanionResultReference

ResultsManipulationBuilder.SetCompanionResultReference

The companion Result Reference if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult

Signature SetCompanionResultReference(tResultRef)

Parameters:tResultRef (NXOpen.CAE.SimResultReference) – set companion result reference

New in version NX10.0.0.

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

SetCompanionSolution

ResultsManipulationBuilder.SetCompanionSolution

The companion solution if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateCompanionResult

Signature SetCompanionSolution(solution)

Parameters:solution (NXOpen.CAE.SimSolution) – set companion solution

New in version NX7.5.2.

Deprecated since version NX10.0.0: Use SetCompanionResultReference() instead.

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

SetCreateSolution

ResultsManipulationBuilder.SetCreateSolution

Specifies whether to create an imported solution

Signature SetCreateSolution(createSolution)

Parameters:createSolution (bool) –

New in version NX9.0.0.

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

SetImportResult

ResultsManipulationBuilder.SetImportResult

Import the result immediately

Signature SetImportResult(importResult)

Parameters:importResult (bool) – nodes and elements will be included

New in version NX8.5.0.

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

SetImportedSolutionName

ResultsManipulationBuilder.SetImportedSolutionName

The imported solution name if action is NXOpen.CAE.ResultsManipulationBuilderAction.CreateImportedSolution

Signature SetImportedSolutionName(importedSolutionName)

Parameters:importedSolutionName (str) – set imported solution name

New in version NX8.5.0.

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

SetIncludeModel

ResultsManipulationBuilder.SetIncludeModel

Include nodes and elements

Signature SetIncludeModel(includeModel)

Parameters:includeModel (bool) – nodes and elements will be included

New in version NX8.5.0.

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

SetLoadcaseName

ResultsManipulationBuilder.SetLoadcaseName

The load case name

Signature SetLoadcaseName(loadcaseName)

Parameters:loadcaseName (str) – set load case name

New in version NX7.5.2.

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

SetOutputFile

ResultsManipulationBuilder.SetOutputFile

The output file

Signature SetOutputFile(outputFile)

Parameters:outputFile (str) – set output file

New in version NX7.5.2.

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

SetOutputName

ResultsManipulationBuilder.SetOutputName

The output name

Signature SetOutputName(outputName)

Parameters:outputName (str) – set output name

New in version NX7.5.2.

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

SetOutputQuantity

ResultsManipulationBuilder.SetOutputQuantity

The output quantity

Signature SetOutputQuantity(quantity)

Parameters:quantity (NXOpen.CAE.ResultQuantity) – not all values may be valid

New in version NX8.5.0.

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

SetOutputResultType

ResultsManipulationBuilder.SetOutputResultType

The result output type

Signature SetOutputResultType(type)

Parameters:type (NXOpen.CAE.ResultsManipulationBuilderOutputResultType) –

New in version NX9.0.0.

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

SetUnitsSystem

ResultsManipulationBuilder.SetUnitsSystem

The units system

Signature SetUnitsSystem(unitsSystem)

Parameters:unitsSystem (NXOpen.CAE.ResultsManipulationBuilderUnitsSystem) – set units system

New in version NX8.5.0.

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

SetUnitsSystemResult

ResultsManipulationBuilder.SetUnitsSystemResult

The result to copy the units system from

Signature SetUnitsSystemResult(result)

Parameters:result (NXOpen.CAE.Result) – set the result for the units system

New in version NX8.5.0.

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

SetUserDefinedUnitsSystem

ResultsManipulationBuilder.SetUserDefinedUnitsSystem

The user-defined units system

Signature SetUserDefinedUnitsSystem(unitsSystem)

Parameters:unitsSystem (NXOpen.CAE.ResultResultBasicUnit_Struct) – set user-defined units system

New in version NX8.5.0.

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

Validate

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