NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::ResultsManipulationBuilder Class Reference

Represents an abstract NXOpen::CAE::ResultsManipulationBuilder
This is an abstract class and cannot be instantiated

Created in NX7.5.2. More...

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

Public Types

enum  Action {
  ActionExport, ActionExportResultsOnly, ActionExportResultsAndModel, ActionCreateImportedResult,
  ActionCreateCompanionResult, ActionCreateCompanionResultWithModel, ActionCreateImportedSolution
}
 Action options
More...
 
enum  ElementValueAtNode { ElementValueAtNodeAverage, ElementValueAtNodeMaximum, ElementValueAtNodeMinimum, ElementValueAtNodeSum }
 Value at Nodes for element nodal values. More...
 
enum  OutputResultType { OutputResultTypeCompanion, OutputResultTypeFull }
 Output result types. More...
 
enum  ResultAppendMethod { ResultAppendMethodCreateNewLoadCases, ResultAppendMethodMergeWithPrimaryResultsData }
 Result Append Method options. More...
 
enum  UnitsSystem { UnitsSystemNone, UnitsSystemFromResult, UnitsSystemUserDefined }
 Units system options. More...
 

Public Member Functions

void SetAction (NXOpen::CAE::ResultsManipulationBuilder::Action action)
 The action
More...
 
void SetAppendMethod (NXOpen::CAE::ResultsManipulationBuilder::ResultAppendMethod appendMethod)
 The append method if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0. More...
 
void SetCompanionResultName (const NXString &companionResultName)
 The companion result name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0. More...
 
void SetCompanionResultName (const char *companionResultName)
 The companion result name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0. More...
 
void SetCompanionResultReference (NXOpen::CAE::SimResultReference *tResultRef)
 The companion Result Reference if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX10.0.0. More...
 
void SetCompanionSolution (NXOpen::CAE::SimSolution *solution)
 The companion solution if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
More...
 
void SetCreateSolution (bool createSolution)
 Specifies whether to create an imported solution
Created in NX9.0.0. More...
 
void SetImportedSolutionName (const NXString &importedSolutionName)
 The imported solution name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateImportedSolution
Created in NX8.5.0. More...
 
void SetImportedSolutionName (const char *importedSolutionName)
 The imported solution name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateImportedSolution
Created in NX8.5.0. More...
 
void SetImportResult (bool importResult)
 Import the result immediately
Created in NX8.5.0. More...
 
void SetIncludeModel (bool includeModel)
 Include nodes and elements
Created in NX8.5.0. More...
 
void SetLoadcaseName (const NXString &loadcaseName)
 The load case name
Created in NX7.5.2. More...
 
void SetLoadcaseName (const char *loadcaseName)
 The load case name
Created in NX7.5.2. More...
 
void SetOutputFile (const NXString &outputFile)
 The output file
Created in NX7.5.2. More...
 
void SetOutputFile (const char *outputFile)
 The output file
Created in NX7.5.2. More...
 
void SetOutputName (const NXString &outputName)
 The output name
Created in NX7.5.2. More...
 
void SetOutputName (const char *outputName)
 The output name
Created in NX7.5.2. More...
 
void SetOutputQuantity (NXOpen::CAE::Result::Quantity quantity)
 The output quantity
Created in NX8.5.0. More...
 
void SetOutputResultType (NXOpen::CAE::ResultsManipulationBuilder::OutputResultType type)
 The result output type
Created in NX9.0.0. More...
 
void SetUnitsSystem (NXOpen::CAE::ResultsManipulationBuilder::UnitsSystem unitsSystem)
 The units system
Created in NX8.5.0. More...
 
void SetUnitsSystemResult (NXOpen::CAE::Result *result)
 The result to copy the units system from
Created in NX8.5.0. More...
 
void SetUserDefinedUnitsSystem (const NXOpen::CAE::Result::ResultBasicUnit &unitsSystem)
 The user-defined units system
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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...
 

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

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAE::ResultsManipulationBuilder::OutputResultType instead.

Enumerator
ActionExport 

export

ActionExportResultsOnly 

no longer used

ActionExportResultsAndModel 

no longer used

ActionCreateImportedResult 

no longer used

ActionCreateCompanionResult 

create companion result

ActionCreateCompanionResultWithModel 

no longer used

ActionCreateImportedSolution 

create imported solution

Value at Nodes for element nodal values.

Enumerator
ElementValueAtNodeAverage 

average

ElementValueAtNodeMaximum 

maximum

ElementValueAtNodeMinimum 

minimum

ElementValueAtNodeSum 

sum

Output result types.

Enumerator
OutputResultTypeCompanion 

companion

OutputResultTypeFull 

full

Result Append Method options.

Enumerator
ResultAppendMethodCreateNewLoadCases 

create new load cases

ResultAppendMethodMergeWithPrimaryResultsData 

merge with primary results data

Units system options.

Enumerator
UnitsSystemNone 

none

UnitsSystemFromResult 

from result

UnitsSystemUserDefined 

user defined

Member Function Documentation

void NXOpen::CAE::ResultsManipulationBuilder::SetAction ( NXOpen::CAE::ResultsManipulationBuilder::Action  action)

The action

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAE::ResultsManipulationBuilder::SetOutputResultType instead.


Created in NX7.5.2.

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

Parameters
actionset action
void NXOpen::CAE::ResultsManipulationBuilder::SetAppendMethod ( NXOpen::CAE::ResultsManipulationBuilder::ResultAppendMethod  appendMethod)

The append method if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0.



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

Parameters
appendMethodset append method
void NXOpen::CAE::ResultsManipulationBuilder::SetCompanionResultName ( const NXString companionResultName)

The companion result name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0.



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

Parameters
companionResultNameset companion result name
void NXOpen::CAE::ResultsManipulationBuilder::SetCompanionResultName ( const char *  companionResultName)

The companion result name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX8.5.0.



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

Parameters
companionResultNameset companion result name
void NXOpen::CAE::ResultsManipulationBuilder::SetCompanionResultReference ( NXOpen::CAE::SimResultReference tResultRef)

The companion Result Reference if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult
Created in NX10.0.0.



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

Parameters
tResultRefset companion result reference
void NXOpen::CAE::ResultsManipulationBuilder::SetCompanionSolution ( NXOpen::CAE::SimSolution solution)

The companion solution if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateCompanionResult

Deprecated:
Deprecated in NX10.0.0.

Use SetCompanionResultReference instead.


Created in NX7.5.2.

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

Parameters
solutionset companion solution
void NXOpen::CAE::ResultsManipulationBuilder::SetCreateSolution ( bool  createSolution)

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
createSolutioncreatesolution
void NXOpen::CAE::ResultsManipulationBuilder::SetImportedSolutionName ( const NXString importedSolutionName)

The imported solution name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateImportedSolution
Created in NX8.5.0.



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

Parameters
importedSolutionNameset imported solution name
void NXOpen::CAE::ResultsManipulationBuilder::SetImportedSolutionName ( const char *  importedSolutionName)

The imported solution name if action is NXOpen::CAE::ResultsManipulationBuilder::ActionCreateImportedSolution
Created in NX8.5.0.



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

Parameters
importedSolutionNameset imported solution name
void NXOpen::CAE::ResultsManipulationBuilder::SetImportResult ( bool  importResult)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetIncludeModel ( bool  includeModel)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetLoadcaseName ( const NXString loadcaseName)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetLoadcaseName ( const char *  loadcaseName)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputFile ( const NXString outputFile)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputFile ( const char *  outputFile)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputName ( const NXString outputName)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputName ( const char *  outputName)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputQuantity ( NXOpen::CAE::Result::Quantity  quantity)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetOutputResultType ( NXOpen::CAE::ResultsManipulationBuilder::OutputResultType  type)

The result output type
Created in NX9.0.0.



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

Parameters
typetype
void NXOpen::CAE::ResultsManipulationBuilder::SetUnitsSystem ( NXOpen::CAE::ResultsManipulationBuilder::UnitsSystem  unitsSystem)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetUnitsSystemResult ( NXOpen::CAE::Result result)

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
void NXOpen::CAE::ResultsManipulationBuilder::SetUserDefinedUnitsSystem ( const NXOpen::CAE::Result::ResultBasicUnit unitsSystem)

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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.