NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::CompanionResultBuilder Class Reference

Represents a CAE::CompanionResult builder and can be used to create or edit an CAE::CompanionResult
To create a new instance of this class, use CAE::CompanionResultCollection::CreateCompanionResultBuilder
Default values. More...

Inheritance diagram for NXOpen::CAE::CompanionResultBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.
NXOpen::CAE::CompanionResultCommitResult ()
 Commits any edits that have been applied to the builder, This method must be used instead of commit if you want to get the CAE::CompanionResult returned.
NXString CompanionResultsFile ()
 Returns the companion results file name.
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.
NXString Name ()
 Returns the name given to this Solutions Companion Result object.
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.
void SetCompanionResultsFile (const NXString &filename)
 Sets the companion results file name.
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.
void SetName (const NXString &name)
 Sets the name given to this Solutions Companion Result object.

Detailed Description

Represents a CAE::CompanionResult builder and can be used to create or edit an CAE::CompanionResult
To create a new instance of this class, use CAE::CompanionResultCollection::CreateCompanionResultBuilder
Default values.

Property Value

AppendMethod

CreateNewLoadCases

Disposition

Delete


Created in NX7.5.0.


Member Enumeration Documentation

Companion result disposition indicates how the Companion result will be disposed of when primary result is deleted.

Enumerator:
CompanionResultDispositionDelete 

Companion Result Object will be deleted when primary results are deleted.

CompanionResultDispositionKeep 

The Companion Result Object will be keep when primary results are deleted so that when the primary results are later regenerated these companion results will again be available.

Companion results appending method which indicates how Companion results will be appended to the existing primary results.

Enumerator:
ResultAppendMethodCreateNewLoadCases 

Companion results will be created in new separate load cases.

ResultAppendMethodMergeWithPrimaryResultsData 

Companion results will be merged with existing load cases if possible, else new load cases will be created.


Member Function Documentation

Returns the append method indicate how the companion results data will be presented
Created in NX7.5.0.



License requirements : None

Commits any edits that have been applied to the builder, This method must be used instead of commit if you want to get the CAE::CompanionResult returned.

This is because the CAE::CompanionResult is not an NXObject which is returned by the standard builder

Returns:

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Returns the companion results file name.


Created in NX7.5.0.

License requirements : None

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

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

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")

Parameters:
appendMethodappendmethod

Sets the companion results file name.


Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
filenamefilename

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")

Parameters:
dispositiondisposition

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")

Parameters:
namename

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.