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

Represents a NXOpen::CAE::ResultsCombinationBuilder
To obtain an instance of this class use NXOpen::Session::ResultManager . More...

Inheritance diagram for NXOpen::CAE::ResultsCombinationBuilder:
NXOpen::CAE::ResultsManipulationBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  EvaluationError { EvaluationErrorSkip, EvaluationErrorZeroFill, EvaluationErrorAbort }
 evaluation error options More...
 
enum  IncompatibleResults { IncompatibleResultsSkip, IncompatibleResultsAbort }
 Incompatible results options. More...
 
enum  NoData { NoDataSkip, NoDataZeroFill }
 No data options. More...
 
enum  Output { OutputExportResultFile, OutputCreateField }
 output types More...
 
- Public Types inherited from NXOpen::CAE::ResultsManipulationBuilder
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 SetDependentDomain (NXOpen::Fields::FieldDomain *domain)
 Set Dependent Domain
Created in NX12.0.0. More...
 
void SetDependentDomainName (const NXString &domainName)
 Set Dependent Domain Name
More...
 
void SetDependentDomainName (const char *domainName)
 Set Dependent Domain Name
More...
 
void SetElementValueAtNode (NXOpen::CAE::ResultsManipulationBuilder::ElementValueAtNode value)
 Set element value to be used at a node
Created in NX9.0.0. More...
 
void SetEvaluationErrorOption (NXOpen::CAE::ResultsCombinationBuilder::EvaluationError evaluationErrorOption)
 Set evaluation error option
Created in NX7.5.2. More...
 
void SetFieldName (const NXString &fieldName)
 Set field Name to be created
Created in NX9.0.0. More...
 
void SetFieldName (const char *fieldName)
 Set field Name to be created
Created in NX9.0.0. More...
 
void SetFormula (const NXString &formula)
 The formula
Created in NX7.5.2. More...
 
void SetFormula (const char *formula)
 The formula
Created in NX7.5.2. More...
 
void SetIncompatibleResultsOption (NXOpen::CAE::ResultsCombinationBuilder::IncompatibleResults incompatibleResultsOption)
 Set incompatible results option
Created in NX7.5.2. More...
 
void SetIndependentDomain (NXOpen::Fields::FieldDomain *domain)
 Set Independent Domain
Created in NX12.0.0. More...
 
void SetIndependentDomainName (const NXString &domainName)
 Set Independent Domain Name
More...
 
void SetIndependentDomainName (const char *domainName)
 Set Independent Domain Name
More...
 
void SetNoDataOption (NXOpen::CAE::ResultsCombinationBuilder::NoData noDataOption)
 Set no data option
Created in NX7.5.2. More...
 
void SetOutput (NXOpen::CAE::ResultsCombinationBuilder::Output output)
 Set output type from result combination
Created in NX9.0.0. More...
 
void SetResultTypes (const std::vector< NXOpen::CAE::BaseResultType * > &types, std::vector< NXString > &names)
 The result types
Created in NX7.5.2. More...
 
void SetResultTypes (const std::vector< NXOpen::CAE::BaseResultType * > &types, std::vector< NXString > &names, const std::vector< NXOpen::Unit * > &units)
 The result types
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::ResultsManipulationBuilder
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 a NXOpen::CAE::ResultsCombinationBuilder
To obtain an instance of this class use NXOpen::Session::ResultManager .



Created in NX7.5.2.

Member Enumeration Documentation

evaluation error options

Enumerator
EvaluationErrorSkip 

skip

EvaluationErrorZeroFill 

zero fill

EvaluationErrorAbort 

abort

Incompatible results options.

Enumerator
IncompatibleResultsSkip 

skip

IncompatibleResultsAbort 

abort

No data options.

Enumerator
NoDataSkip 

skip

NoDataZeroFill 

zero fill

output types

Enumerator
OutputExportResultFile 

export result file

OutputCreateField 

create field

Member Function Documentation

void NXOpen::CAE::ResultsCombinationBuilder::SetDependentDomain ( NXOpen::Fields::FieldDomain domain)

Set Dependent Domain
Created in NX12.0.0.



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

Parameters
domainDependent Domain
void NXOpen::CAE::ResultsCombinationBuilder::SetDependentDomainName ( const NXString domainName)

Set Dependent Domain Name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::ResultsCombinationBuilder::SetDependentDomain instead.


Created in NX9.0.0.

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

Parameters
domainNamedomain name
void NXOpen::CAE::ResultsCombinationBuilder::SetDependentDomainName ( const char *  domainName)

Set Dependent Domain Name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::ResultsCombinationBuilder::SetDependentDomain instead.


Created in NX9.0.0.

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

Parameters
domainNamedomain name
void NXOpen::CAE::ResultsCombinationBuilder::SetElementValueAtNode ( NXOpen::CAE::ResultsManipulationBuilder::ElementValueAtNode  value)

Set element value to be used at a node
Created in NX9.0.0.



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

Parameters
valuevalue
void NXOpen::CAE::ResultsCombinationBuilder::SetEvaluationErrorOption ( NXOpen::CAE::ResultsCombinationBuilder::EvaluationError  evaluationErrorOption)

Set evaluation error option
Created in NX7.5.2.



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

Parameters
evaluationErrorOptionevaluationerroroption
void NXOpen::CAE::ResultsCombinationBuilder::SetFieldName ( const NXString fieldName)

Set field Name to be created
Created in NX9.0.0.



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

Parameters
fieldNamefieldname
void NXOpen::CAE::ResultsCombinationBuilder::SetFieldName ( const char *  fieldName)

Set field Name to be created
Created in NX9.0.0.



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

Parameters
fieldNamefieldname
void NXOpen::CAE::ResultsCombinationBuilder::SetFormula ( const NXString formula)

The formula
Created in NX7.5.2.



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

Parameters
formulaset formula
void NXOpen::CAE::ResultsCombinationBuilder::SetFormula ( const char *  formula)

The formula
Created in NX7.5.2.



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

Parameters
formulaset formula
void NXOpen::CAE::ResultsCombinationBuilder::SetIncompatibleResultsOption ( NXOpen::CAE::ResultsCombinationBuilder::IncompatibleResults  incompatibleResultsOption)

Set incompatible results option
Created in NX7.5.2.



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

Parameters
incompatibleResultsOptionincompatibleresultsoption
void NXOpen::CAE::ResultsCombinationBuilder::SetIndependentDomain ( NXOpen::Fields::FieldDomain domain)

Set Independent Domain
Created in NX12.0.0.



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

Parameters
domainIndependent Domain
void NXOpen::CAE::ResultsCombinationBuilder::SetIndependentDomainName ( const NXString domainName)

Set Independent Domain Name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::ResultsCombinationBuilder::SetIndependentDomain instead.


Created in NX9.0.0.

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

Parameters
domainNamedomain name
void NXOpen::CAE::ResultsCombinationBuilder::SetIndependentDomainName ( const char *  domainName)

Set Independent Domain Name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::ResultsCombinationBuilder::SetIndependentDomain instead.


Created in NX9.0.0.

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

Parameters
domainNamedomain name
void NXOpen::CAE::ResultsCombinationBuilder::SetNoDataOption ( NXOpen::CAE::ResultsCombinationBuilder::NoData  noDataOption)

Set no data option
Created in NX7.5.2.



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

Parameters
noDataOptionnodataoption
void NXOpen::CAE::ResultsCombinationBuilder::SetOutput ( NXOpen::CAE::ResultsCombinationBuilder::Output  output)

Set output type from result combination
Created in NX9.0.0.



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

Parameters
outputoutput
void NXOpen::CAE::ResultsCombinationBuilder::SetResultTypes ( const std::vector< NXOpen::CAE::BaseResultType * > &  types,
std::vector< NXString > &  names 
)

The result types
Created in NX7.5.2.



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

Parameters
typesset result types
namesset result names
void NXOpen::CAE::ResultsCombinationBuilder::SetResultTypes ( const std::vector< NXOpen::CAE::BaseResultType * > &  types,
std::vector< NXString > &  names,
const std::vector< NXOpen::Unit * > &  units 
)

The result types
Created in NX8.5.0.



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

Parameters
typesset result types
namesset result names
unitsunits

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