Represents a @link CAE::CompanionResult CAE::CompanionResult@endlink  builder and can 
    be used to create or edit an @link CAE::CompanionResult CAE::CompanionResult@endlink   <br> To create a new instance of this class, use @link CAE::CompanionResultCollection::CreateCompanionResultBuilder  CAE::CompanionResultCollection::CreateCompanionResultBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::CAE::CompanionResultBuilder:

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::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 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	SetCompanionResultsFile (const char *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.

void	SetName (const char *name)
	Sets the name given to this Solutions Companion Result object.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a @link CAE::CompanionResult CAE::CompanionResult@endlink  builder and can 
    be used to create or edit an @link CAE::CompanionResult CAE::CompanionResult@endlink   <br> To create a new instance of this class, use @link CAE::CompanionResultCollection::CreateCompanionResultBuilder  CAE::CompanionResultCollection::CreateCompanionResultBuilder @endlink  <br>

Default values.

Property

Value

AppendMethod

CreateNewLoadCases

Disposition

Delete

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::CAE::CompanionResultBuilder::CompanionResultDisposition

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.

enum NXOpen::CAE::CompanionResultBuilder::ResultAppendMethod

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

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

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

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

name name

The documentation for this class was generated from the following file:

CAE_CompanionResultBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation