NX Open C++ Reference Guide
|
Represents a NXOpen::CAE::CompanionResult builder and can be used to create or edit an NXOpen::CAE::CompanionResult
To create a new instance of this class, use NXOpen::CAE::CompanionResultCollection::CreateCompanionResultBuilder
Default values.
More...
Public Types | |
enum | CompanionResultDisposition { CompanionResultDispositionDelete, CompanionResultDispositionKeep } |
Companion result disposition indicates how the Companion result will be disposed of when primary result is deleted. More... | |
enum | ResultAppendMethod { ResultAppendMethodCreateNewLoadCases, ResultAppendMethodMergeWithPrimaryResultsData } |
Companion results appending method which indicates how Companion results will be appended to the existing primary results. More... | |
Public Member Functions | |
NXOpen::CAE::CompanionResultBuilder::ResultAppendMethod | AppendMethod () |
Returns the append method indicate how the companion results data will be presented Created in NX7.5.0. More... | |
NXOpen::CAE::CompanionResult * | 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. More... | |
NXString | CompanionResultsFile () |
Returns the companion results file name. More... | |
NXOpen::CAE::CompanionResultBuilder::CompanionResultDisposition | Disposition () |
Returns the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone. More... | |
NXString | Name () |
Returns the name given to this Solutions Companion Result object. More... | |
void | SetAppendMethod (NXOpen::CAE::CompanionResultBuilder::ResultAppendMethod appendMethod) |
Sets the append method indicate how the companion results data will be presented Created in NX7.5.0. More... | |
void | SetCompanionResultsFile (const NXString &filename) |
Sets the companion results file name. More... | |
void | SetCompanionResultsFile (const char *filename) |
Sets the companion results file name. More... | |
void | SetDisposition (NXOpen::CAE::CompanionResultBuilder::CompanionResultDisposition disposition) |
Sets the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone. More... | |
void | SetName (const NXString &name) |
Sets the name given to this Solutions Companion Result object. More... | |
void | SetName (const char *name) |
Sets the name given to this Solutions Companion Result object. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a NXOpen::CAE::CompanionResult builder and can be used to create or edit an NXOpen::CAE::CompanionResult
To create a new instance of this class, use NXOpen::CAE::CompanionResultCollection::CreateCompanionResultBuilder
Default values.
Property | Value |
---|---|
AppendMethod |
CreateNewLoadCases |
Disposition |
Delete |
Created in NX7.5.0.
Companion result disposition indicates how the Companion result will be disposed of when primary result is deleted.
Companion results appending method which indicates how Companion results will be appended to the existing primary results.
NXOpen::CAE::CompanionResultBuilder::ResultAppendMethod NXOpen::CAE::CompanionResultBuilder::AppendMethod | ( | ) |
Returns the append method indicate how the companion results data will be presented
Created in NX7.5.0.
License requirements : None
NXOpen::CAE::CompanionResult* NXOpen::CAE::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 an NXOpen::NXObject which is returned by the standard builder
NXString NXOpen::CAE::CompanionResultBuilder::CompanionResultsFile | ( | ) |
Returns the companion results file name.
Created in NX7.5.0.
License requirements : None
NXOpen::CAE::CompanionResultBuilder::CompanionResultDisposition NXOpen::CAE::CompanionResultBuilder::Disposition | ( | ) |
Returns the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone.
Created in NX7.5.0.
License requirements : None
NXString NXOpen::CAE::CompanionResultBuilder::Name | ( | ) |
Returns the name given to this Solutions Companion Result object.
Used for user display and identification purposes.
Created in NX7.5.0.
License requirements : None
void NXOpen::CAE::CompanionResultBuilder::SetAppendMethod | ( | NXOpen::CAE::CompanionResultBuilder::ResultAppendMethod | appendMethod | ) |
Sets the append method indicate how the companion results data will be presented
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
appendMethod | appendmethod |
void NXOpen::CAE::CompanionResultBuilder::SetCompanionResultsFile | ( | const NXString & | filename | ) |
Sets the companion results file name.
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
filename | filename |
void NXOpen::CAE::CompanionResultBuilder::SetCompanionResultsFile | ( | const char * | filename | ) |
Sets the companion results file name.
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
filename | filename |
void NXOpen::CAE::CompanionResultBuilder::SetDisposition | ( | NXOpen::CAE::CompanionResultBuilder::CompanionResultDisposition | disposition | ) |
Sets the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone.
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
disposition | disposition |
void NXOpen::CAE::CompanionResultBuilder::SetName | ( | const NXString & | name | ) |
Sets the name given to this Solutions Companion Result object.
Used for user display and identification purposes.
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
name | name |
void NXOpen::CAE::CompanionResultBuilder::SetName | ( | const char * | name | ) |
Sets the name given to this Solutions Companion Result object.
Used for user display and identification purposes.
Created in NX7.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
name | name |