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

Represents an abstract NXOpen.CAE.ResultsManipulationBuilder More...

Inheritance diagram for NXOpen.CAE.ResultsManipulationBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.CAE.ResultsCombinationBuilder NXOpen.CAE.ResultsEnvelopeBuilder NXOpen.CAE.ResultsModelExportBuilder NXOpen.CAE.ResultsReductionBuilder NXOpen.CAE.TransientResultsReductionBuilder

Public Types

enum  Action {
  Export, ExportResultsOnly, ExportResultsAndModel, CreateImportedResult,
  CreateCompanionResult, CreateCompanionResultWithModel, CreateImportedSolution
}
 Action options More...
 
enum  ElementValueAtNode { Average, Maximum, Minimum, Sum }
 Value at Nodes for element nodal values More...
 
enum  OutputResultType { Companion, Full }
 Output result types More...
 
enum  ResultAppendMethod { CreateNewLoadCases, MergeWithPrimaryResultsData }
 Result Append Method options More...
 
enum  UnitsSystem { None, FromResult, UserDefined }
 Units system options More...
 

Public Member Functions

unsafe void SetAction (NXOpen.CAE.ResultsManipulationBuilder.Action action)
 The action More...
 
unsafe void SetAppendMethod (NXOpen.CAE.ResultsManipulationBuilder.ResultAppendMethod appendMethod)
 The append method if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult More...
 
unsafe void SetCompanionResultName (string companionResultName)
 The companion result name if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult More...
 
unsafe void SetCompanionResultReference (NXOpen.CAE.SimResultReference tResultRef)
 The companion Result Reference if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult More...
 
unsafe void SetCompanionSolution (NXOpen.CAE.SimSolution solution)
 The companion solution if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult More...
 
unsafe void SetCreateSolution (bool createSolution)
 Specifies whether to create an imported solution More...
 
unsafe void SetImportedSolutionName (string importedSolutionName)
 The imported solution name if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateImportedSolution More...
 
unsafe void SetImportResult (bool importResult)
 Import the result immediately More...
 
unsafe void SetIncludeModel (bool includeModel)
 Include nodes and elements More...
 
unsafe void SetLoadcaseName (string loadcaseName)
 The load case name More...
 
unsafe void SetOutputFile (string outputFile)
 The output file More...
 
unsafe void SetOutputName (string outputName)
 The output name More...
 
unsafe void SetOutputQuantity (NXOpen.CAE.Result.Quantity quantity)
 The output quantity More...
 
unsafe void SetOutputResultType (NXOpen.CAE.ResultsManipulationBuilder.OutputResultType type)
 The result output type More...
 
unsafe void SetUnitsSystem (NXOpen.CAE.ResultsManipulationBuilder.UnitsSystem unitsSystem)
 The units system More...
 
unsafe void SetUnitsSystemResult (NXOpen.CAE.Result result)
 The result to copy the units system from More...
 
unsafe void SetUserDefinedUnitsSystem (NXOpen.CAE.Result.ResultBasicUnit unitsSystem)
 The user-defined units system 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...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 

Detailed Description

Represents an abstract NXOpen.CAE.ResultsManipulationBuilder

This is an abstract class and cannot be instantiated

Created in NX7.5.2

Member Enumeration Documentation

Action options

Enumerator
Export 
ExportResultsOnly 

no longer used

ExportResultsAndModel 

no longer used

CreateImportedResult 

no longer used

CreateCompanionResult 
CreateCompanionResultWithModel 

no longer used

CreateImportedSolution 

Value at Nodes for element nodal values

Enumerator
Average 
Maximum 
Minimum 
Sum 

Output result types

Enumerator
Companion 
Full 

Result Append Method options

Enumerator
CreateNewLoadCases 
MergeWithPrimaryResultsData 

Units system options

Enumerator
None 
FromResult 
UserDefined 

Member Function Documentation

unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetAction ( NXOpen.CAE.ResultsManipulationBuilder.Action  action)
inline

The action

Created in NX7.5.2

Deprecated in NX9.0.0. Use NXOpen.CAE.ResultsManipulationBuilder.SetOutputResultType instead.

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
actionset action
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetAppendMethod ( NXOpen.CAE.ResultsManipulationBuilder.ResultAppendMethod  appendMethod)
inline

The append method if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
appendMethodset append method
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetCompanionResultName ( string  companionResultName)
inline

The companion result name if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
companionResultNameset companion result name
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetCompanionResultReference ( NXOpen.CAE.SimResultReference  tResultRef)
inline

The companion Result Reference if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
tResultRefset companion result reference
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetCompanionSolution ( NXOpen.CAE.SimSolution  solution)
inline

The companion solution if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateCompanionResult

Created in NX7.5.2

Deprecated in NX10.0.0. Use SetCompanionResultReference instead.

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
solutionset companion solution
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetCreateSolution ( bool  createSolution)
inline

Specifies whether to create an imported solution

Created in NX9.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
createSolution
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetImportedSolutionName ( string  importedSolutionName)
inline

The imported solution name if action is NXOpen.CAE.ResultsManipulationBuilder.Action.CreateImportedSolution

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
importedSolutionNameset imported solution name
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetImportResult ( bool  importResult)
inline

Import the result immediately

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
importResultnodes and elements will be included
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetIncludeModel ( bool  includeModel)
inline

Include nodes and elements

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
includeModelnodes and elements will be included
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetLoadcaseName ( string  loadcaseName)
inline

The load case name

Created in NX7.5.2

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
loadcaseNameset load case name
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetOutputFile ( string  outputFile)
inline

The output file

Created in NX7.5.2

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
outputFileset output file
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetOutputName ( string  outputName)
inline

The output name

Created in NX7.5.2

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
outputNameset output name
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetOutputQuantity ( NXOpen.CAE.Result.Quantity  quantity)
inline

The output quantity

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
quantitynot all values may be valid
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetOutputResultType ( NXOpen.CAE.ResultsManipulationBuilder.OutputResultType  type)
inline

The result output type

Created in NX9.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
type
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetUnitsSystem ( NXOpen.CAE.ResultsManipulationBuilder.UnitsSystem  unitsSystem)
inline

The units system

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
unitsSystemset units system
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetUnitsSystemResult ( NXOpen.CAE.Result  result)
inline

The result to copy the units system from

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
resultset the result for the units system
unsafe void NXOpen.CAE.ResultsManipulationBuilder.SetUserDefinedUnitsSystem ( NXOpen.CAE.Result.ResultBasicUnit  unitsSystem)
inline

The user-defined units system

Created in NX8.5.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
unitsSystemset user-defined units system

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