CompanionResultBuilder Class¶
-
class
NXOpen.CAE.
CompanionResultBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.CAE.CompanionResult
builder and can be used to create or edit anNXOpen.CAE.CompanionResult
To create a new instance of this class, use
NXOpen.CAE.CompanionResultCollection.CreateCompanionResultBuilder
Default values.
Property Value AppendMethod CreateNewLoadCases Disposition Delete New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AppendMethod | Returns or sets the append method indicate how the companion results data will be presented |
CompanionResultsFile | Returns or sets the companion results file name. |
Disposition | Returns or sets the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone. |
Name | Returns or sets the name given to this Solutions Companion Result object. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitResult | Commits any edits that have been applied to the builder, This method must be used instead of commit if you want to get the NXOpen.CAE.CompanionResult returned. |
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. |
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¶
CompanionResultBuilderCompanionResultDisposition Enumeration | Companion result disposition indicates how the Companion result will be disposed of when primary result is deleted. |
CompanionResultBuilderResultAppendMethod Enumeration | Companion results appending method which indicates how Companion results will be appended to the existing primary results. |
Property Detail¶
AppendMethod¶
-
CompanionResultBuilder.
AppendMethod
¶ Returns or sets the append method indicate how the companion results data will be presented
-------------------------------------
Getter Method
Signature
AppendMethod()
Returns: Return type: NXOpen.CAE.CompanionResultBuilderResultAppendMethod
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendMethod(appendMethod)
Parameters: appendMethod ( NXOpen.CAE.CompanionResultBuilderResultAppendMethod
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
CompanionResultsFile¶
-
CompanionResultBuilder.
CompanionResultsFile
¶ Returns or sets the companion results file name.
-------------------------------------
Getter Method
Signature
CompanionResultsFile()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CompanionResultsFile(filename)
Parameters: filename (str) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Disposition¶
-
CompanionResultBuilder.
Disposition
¶ Returns or sets the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone.
-------------------------------------
Getter Method
Signature
Disposition()
Returns: Return type: NXOpen.CAE.CompanionResultBuilderCompanionResultDisposition
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Disposition(disposition)
Parameters: disposition ( NXOpen.CAE.CompanionResultBuilderCompanionResultDisposition
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Name¶
-
CompanionResultBuilder.
Name
¶ Returns or sets the name given to this Solutions Companion Result object.
Used for user display and identification purposes.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
CommitResult¶
-
CompanionResultBuilder.
CommitResult
¶ Commits any edits that have been applied to the builder, This method must be used instead of commit if you want to get the
NXOpen.CAE.CompanionResult
returned.This is because the
NXOpen.CAE.CompanionResult
is not anNXOpen.NXObject
which is returned by the standard builderSignature
CommitResult()
Returns: Return type: NXOpen.CAE.CompanionResult
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Validate¶
-
CompanionResultBuilder.
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.