NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.CompanionResultBuilder Class Reference

Represents a NXOpen.CAE.CompanionResult builder and can be used to create or edit an NXOpen.CAE.CompanionResult More...

Inheritance diagram for NXOpen.CAE.CompanionResultBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  CompanionResultDisposition { Delete, Keep }
 Companion result disposition indicates how the Companion result will be disposed of when primary result is deleted. More...
 
enum  ResultAppendMethod { CreateNewLoadCases, MergeWithPrimaryResultsData }
 Companion results appending method which indicates how Companion results will be appended to the existing primary results. More...
 

Public Member Functions

unsafe 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...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.CAE.CompanionResultBuilder.ResultAppendMethod 
AppendMethod [get, set]
 Returns or sets the append method indicate how the companion results data will be presented More...
 
unsafe string CompanionResultsFile [get, set]
 Returns or sets the companion results file name. More...
 
unsafe
NXOpen.CAE.CompanionResultBuilder.CompanionResultDisposition 
Disposition [get, set]
 Returns or sets the file disposition attribute indicates how the companion result file will be disposed of when the primary results are gone. More...
 
unsafe string Name [get, set]
 Returns or sets the name given to this Solutions Companion Result object. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Member Enumeration Documentation

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

Enumerator
Delete 

Companion Result Object will be deleted when primary results are deleted

Keep 

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
CreateNewLoadCases 

Companion results will be created in new separate load cases

MergeWithPrimaryResultsData 

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

Member Function Documentation

unsafe NXOpen.CAE.CompanionResult NXOpen.CAE.CompanionResultBuilder.CommitResult ( )
inline

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

Created in NX7.5.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns

Property Documentation

unsafe NXOpen.CAE.CompanionResultBuilder.ResultAppendMethod NXOpen.CAE.CompanionResultBuilder.AppendMethod
getset

Returns or sets the append method indicate how the companion results data will be presented

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

unsafe string NXOpen.CAE.CompanionResultBuilder.CompanionResultsFile
getset

Returns or sets the companion results file name.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

unsafe NXOpen.CAE.CompanionResultBuilder.CompanionResultDisposition NXOpen.CAE.CompanionResultBuilder.Disposition
getset

Returns or 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 to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

unsafe string NXOpen.CAE.CompanionResultBuilder.Name
getset

Returns or sets the name given to this Solutions Companion Result object.

Used for user display and identification purposes.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")


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