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

Represents a Result Reference in the .sim files. More...

Inheritance diagram for NXOpen::CAE::SimResultReference:
NXOpen::TaggedObject NXOpen::CAE::IPostScenarioDataSource

Public Types

enum  Type {
  TypeStructural, TypeThermal, TypeFlow, TypeMagnetics,
  TypeAcoustic, TypeVibroAcoustic
}
 Result Types. More...
 

Public Member Functions

NXOpen::CAE::CompanionResultCollectionCompanionResults ()
 Returns the CAE Companion Results collection belonging to this Result Reference
Created in NX10.0.0. More...
 
NXString GetManagedResultFile ()
 Get the managed result file name. More...
 
void GetResultFile (NXString *resultfiledir, NXString *resfilename)
 Get the result file directory and result file name
Created in NX10.0.0. More...
 
void GetResultFileUnits (std::vector< NXOpen::Unit * > &units)
 Get basic 6 units which are stored with solution used for loading the result file
Created in NX10.0.0. More...
 
void SetInferredResultFile ()
 Clear previously specified result file location
Created in NX10.0.0. More...
 
void SetInferredResultFileUnits ()
 Clears previously specified result file units
Created in NX10.0.0. More...
 
void SetLocalResultFile (const NXString &dirpath, const NXString &filename)
 Specify local result file
Created in NX10.0.0. More...
 
void SetLocalResultFile (const char *dirpath, const char *filename)
 Specify local result file
Created in NX10.0.0. More...
 
void SetManagedResultFile (const NXString &file)
 Specify managed result file
Created in NX10.0.0. More...
 
void SetManagedResultFile (const char *file)
 Specify managed result file
Created in NX10.0.0. More...
 
void SetResultFileUnits (const std::vector< NXOpen::Unit * > &units)
 Set result file units
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Result Reference in the .sim files.

For more information, refer to the Solver language documentation in the SolverLanguageDocumentation.


This class is not created directly by the user.

Created in NX10.0.0.

Member Enumeration Documentation

Result Types.

Enumerator
TypeStructural 

structural result

TypeThermal 

thermal result

TypeFlow 

flow result

TypeMagnetics 

magnetics result

TypeAcoustic 

acoustic result

TypeVibroAcoustic 

vibration acoustic result

Member Function Documentation

NXOpen::CAE::CompanionResultCollection* NXOpen::CAE::SimResultReference::CompanionResults ( )

Returns the CAE Companion Results collection belonging to this Result Reference
Created in NX10.0.0.


NXString NXOpen::CAE::SimResultReference::GetManagedResultFile ( )

Get the managed result file name.

Returns
managed result file name
Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
void NXOpen::CAE::SimResultReference::GetResultFile ( NXString resultfiledir,
NXString resfilename 
)

Get the result file directory and result file name
Created in NX10.0.0.



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

Parameters
resultfiledirdirectly path where result file is stored
resfilenameresult file name
void NXOpen::CAE::SimResultReference::GetResultFileUnits ( std::vector< NXOpen::Unit * > &  units)

Get basic 6 units which are stored with solution used for loading the result file
Created in NX10.0.0.



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

Parameters
units6 basic units used to define the quantities in result file in order of mass, length, time, temperature, angle, and thermal energy
void NXOpen::CAE::SimResultReference::SetInferredResultFile ( )

Clear previously specified result file location
Created in NX10.0.0.



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

void NXOpen::CAE::SimResultReference::SetInferredResultFileUnits ( )

Clears previously specified result file units
Created in NX10.0.0.



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

void NXOpen::CAE::SimResultReference::SetLocalResultFile ( const NXString dirpath,
const NXString filename 
)

Specify local result file
Created in NX10.0.0.



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

Parameters
dirpathdirectory name
filenamefile name
void NXOpen::CAE::SimResultReference::SetLocalResultFile ( const char *  dirpath,
const char *  filename 
)

Specify local result file
Created in NX10.0.0.



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

Parameters
dirpathdirectory name
filenamefile name
void NXOpen::CAE::SimResultReference::SetManagedResultFile ( const NXString file)

Specify managed result file
Created in NX10.0.0.



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

Parameters
filefile name
void NXOpen::CAE::SimResultReference::SetManagedResultFile ( const char *  file)

Specify managed result file
Created in NX10.0.0.



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

Parameters
filefile name
void NXOpen::CAE::SimResultReference::SetResultFileUnits ( const std::vector< NXOpen::Unit * > &  units)

Set result file units
Created in NX10.0.0.



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

Parameters
units6 units for mass, length, time, temperature, angle, and thermal energy

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