ResultsCombinationBuilder Class¶
-
class
NXOpen.CAE.
ResultsCombinationBuilder
¶ Bases:
NXOpen.CAE.ResultsManipulationBuilder
Represents a
NXOpen.CAE.ResultsCombinationBuilder
To obtain an instance of this class use
NXOpen.Session.ResultManager()
.New in version NX7.5.2.
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 combination |
SetOutputFile | The output file |
SetOutputName | The output name |
SetOutputQuantity | The output quantity |
SetOutputResultType | The result output type |
SetResultTypes | 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¶
ResultsCombinationBuilderEvaluationError Enumeration | evaluation error options |
ResultsCombinationBuilderIncompatibleResults Enumeration | Incompatible results options |
ResultsCombinationBuilderNoData Enumeration | No data options |
ResultsCombinationBuilderOutput Enumeration | output types |
Method Detail¶
SetDependentDomain¶
-
ResultsCombinationBuilder.
SetDependentDomain
¶ Set Dependent Domain
Signature
SetDependentDomain(domain)
Parameters: domain ( NXOpen.Fields.FieldDomain
) – Dependent DomainNew in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetDependentDomainName¶
-
ResultsCombinationBuilder.
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.ResultsCombinationBuilder.SetDependentDomain()
instead.License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetElementValueAtNode¶
-
ResultsCombinationBuilder.
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¶
-
ResultsCombinationBuilder.
SetEvaluationErrorOption
¶ Set evaluation error option
Signature
SetEvaluationErrorOption(evaluationErrorOption)
Parameters: evaluationErrorOption ( NXOpen.CAE.ResultsCombinationBuilderEvaluationError
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetFieldName¶
-
ResultsCombinationBuilder.
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¶
-
ResultsCombinationBuilder.
SetFormula
¶ The formula
Signature
SetFormula(formula)
Parameters: formula (str) – set formula New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetIncompatibleResultsOption¶
-
ResultsCombinationBuilder.
SetIncompatibleResultsOption
¶ Set incompatible results option
Signature
SetIncompatibleResultsOption(incompatibleResultsOption)
Parameters: incompatibleResultsOption ( NXOpen.CAE.ResultsCombinationBuilderIncompatibleResults
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetIndependentDomain¶
-
ResultsCombinationBuilder.
SetIndependentDomain
¶ Set Independent Domain
Signature
SetIndependentDomain(domain)
Parameters: domain ( NXOpen.Fields.FieldDomain
) – Independent DomainNew in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetIndependentDomainName¶
-
ResultsCombinationBuilder.
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.ResultsCombinationBuilder.SetIndependentDomain()
instead.License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetNoDataOption¶
-
ResultsCombinationBuilder.
SetNoDataOption
¶ Set no data option
Signature
SetNoDataOption(noDataOption)
Parameters: noDataOption ( NXOpen.CAE.ResultsCombinationBuilderNoData
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetOutput¶
-
ResultsCombinationBuilder.
SetOutput
¶ Set output type from result combination
Signature
SetOutput(output)
Parameters: output ( NXOpen.CAE.ResultsCombinationBuilderOutput
) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetResultTypes¶
-
ResultsCombinationBuilder.
SetResultTypes
¶ Overloaded method SetResultTypes
SetResultTypes(types, names)
SetResultTypes(types, names, units)
-------------------------------------
The result types
Signature
SetResultTypes(types, names)
Parameters: - types (list of
NXOpen.CAE.BaseResultType
) – set result types - names (list of str) – set result names
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
The result types
Signature
SetResultTypes(types, names, units)
Parameters: - types (list of
NXOpen.CAE.BaseResultType
) – set result types - names (list of str) – set result names
- units (list of
NXOpen.Unit
) –
New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Validate¶
-
ResultsCombinationBuilder.
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.