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

Provides methods for managing ResultMeasures NXOpen::CAE::ResultMeasure. More...

Inheritance diagram for NXOpen::CAE::ResultMeasureCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::CAE::ResultMeasureModelSubsetCreateModelSubset (NXOpen::CAE::ResultMeasure::SubsetSelection eSubset)
 Create a model subset for result measure. More...
 
NXOpen::CAE::ResultMeasureResultOptionsCreateNewResultOptions (NXOpen::CAE::SimSolution *tSol, NXOpen::CAE::SimResultReference *tResultReference, NXOpen::CAE::Loadcase *tResultLoadcase, NXOpen::CAE::Iteration *tResultIteration, bool bAllSubiterations, NXOpen::CAE::Iteration *tResultSubIteration, const NXOpen::CAE::Result::Type &pType, NXOpen::CAE::Result::Component eComp)
 Create a result options for result measure. More...
 
NXOpen::CAE::ResultMeasureCreateResultMeasure (NXOpen::CAE::SimSolution *tSol, int iStepIndex, int iIterIndex, const NXOpen::CAE::Result::Type &pType, NXOpen::CAE::Result::Component eComp, const NXString &expName)
 Create a ResultMeasure. More...
 
NXOpen::CAE::ResultMeasureCreateResultMeasure (NXOpen::CAE::SimSolution *tSol, int iStepIndex, int iIterIndex, const NXOpen::CAE::Result::Type &pType, NXOpen::CAE::Result::Component eComp, const char *expName)
 Create a ResultMeasure. More...
 
NXOpen::CAE::ResultMeasureCreateResultMeasureNew (NXOpen::CAE::ResultMeasureResultOptions *pResOpt, NXOpen::CAE::ResultMeasureModelSubset *pSubset, const NXString &expName)
 Create a ResultMeasure. More...
 
NXOpen::CAE::ResultMeasureCreateResultMeasureNew (NXOpen::CAE::ResultMeasureResultOptions *pResOpt, NXOpen::CAE::ResultMeasureModelSubset *pSubset, const char *expName)
 Create a ResultMeasure. More...
 
NXOpen::CAE::ResultMeasureResultOptionsCreateResultOptions (NXOpen::CAE::SimSolution *tSol, int iStepIndex, int iIterIndex, const NXOpen::CAE::Result::Type &pType, NXOpen::CAE::Result::Component eComp)
 Create a result options for result measure. More...
 
NXOpen::CAE::ResultMeasureResultOptionsCreateResultOptionsNew (NXOpen::CAE::SimSolution *tSol, NXOpen::CAE::SimResultReference *tResultReference, int iStepIndex, int iIterIndex, const NXOpen::CAE::Result::Type &pType, NXOpen::CAE::Result::Component eComp)
 Create a result options for result measure. More...
 
void DeleteMeasures (const std::vector< NXOpen::CAE::ResultMeasure * > &objects)
 Delete list of result measures
Created in NX8.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::ResultMeasureFind (const NXString &journalIdentifier)
 Finds the NXOpen::CAE::ResultMeasure with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::ResultMeasureFind (const char *journalIdentifier)
 Finds the NXOpen::CAE::ResultMeasure with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UpdateMeasures (const std::vector< NXOpen::CAE::ResultMeasure * > &objects)
 Update list of result measures. More...
 

Detailed Description

Provides methods for managing ResultMeasures NXOpen::CAE::ResultMeasure.


To obtain an instance of this class, refer to NXOpen::CAE::SimSimulation

Created in NX8.0.0.

Member Function Documentation

iterator NXOpen::CAE::ResultMeasureCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::ResultMeasureModelSubset* NXOpen::CAE::ResultMeasureCollection::CreateModelSubset ( NXOpen::CAE::ResultMeasure::SubsetSelection  eSubset)

Create a model subset for result measure.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
eSubsetesubset
NXOpen::CAE::ResultMeasureResultOptions* NXOpen::CAE::ResultMeasureCollection::CreateNewResultOptions ( NXOpen::CAE::SimSolution tSol,
NXOpen::CAE::SimResultReference tResultReference,
NXOpen::CAE::Loadcase tResultLoadcase,
NXOpen::CAE::Iteration tResultIteration,
bool  bAllSubiterations,
NXOpen::CAE::Iteration tResultSubIteration,
const NXOpen::CAE::Result::Type pType,
NXOpen::CAE::Result::Component  eComp 
)

Create a result options for result measure.

Returns

Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
tSoltsol
tResultReferencetresultreference
tResultLoadcasetresultloadcase
tResultIterationtresultiteration
bAllSubiterationsto be used select all sub iterations
tResultSubIterationtresultsubiteration
pTypeptype
eCompecomp
NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::CreateResultMeasure ( NXOpen::CAE::SimSolution tSol,
int  iStepIndex,
int  iIterIndex,
const NXOpen::CAE::Result::Type pType,
NXOpen::CAE::Result::Component  eComp,
const NXString expName 
)

Create a ResultMeasure.

Returns
The created result measure object
Deprecated:
Deprecated in NX10.0.0. Use NXOpen::CAE::ResultMeasureCollection::CreateResultMeasureNew instead.


Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
tSoltsol
iStepIndexistepindex
iIterIndexiiterindex
pTypeptype
eCompecomp
expNameexpname
NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::CreateResultMeasure ( NXOpen::CAE::SimSolution tSol,
int  iStepIndex,
int  iIterIndex,
const NXOpen::CAE::Result::Type pType,
NXOpen::CAE::Result::Component  eComp,
const char *  expName 
)

Create a ResultMeasure.

Returns
The created result measure object
Deprecated:
Deprecated in NX10.0.0. Use NXOpen::CAE::ResultMeasureCollection::CreateResultMeasureNew instead.


Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
tSoltsol
iStepIndexistepindex
iIterIndexiiterindex
pTypeptype
eCompecomp
expNameexpname
NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::CreateResultMeasureNew ( NXOpen::CAE::ResultMeasureResultOptions pResOpt,
NXOpen::CAE::ResultMeasureModelSubset pSubset,
const NXString expName 
)

Create a ResultMeasure.

Returns
The created result measure object
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
pResOptpresopt
pSubsetThe model subset, can be null
expNameThe new expression name for the result measure
NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::CreateResultMeasureNew ( NXOpen::CAE::ResultMeasureResultOptions pResOpt,
NXOpen::CAE::ResultMeasureModelSubset pSubset,
const char *  expName 
)

Create a ResultMeasure.

Returns
The created result measure object
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
pResOptpresopt
pSubsetThe model subset, can be null
expNameThe new expression name for the result measure
NXOpen::CAE::ResultMeasureResultOptions* NXOpen::CAE::ResultMeasureCollection::CreateResultOptions ( NXOpen::CAE::SimSolution tSol,
int  iStepIndex,
int  iIterIndex,
const NXOpen::CAE::Result::Type pType,
NXOpen::CAE::Result::Component  eComp 
)

Create a result options for result measure.

Returns

Deprecated:
Deprecated in NX10.0.0. Use NXOpen::CAE::SimResultReference :CreateResultMeasureNew instead.


Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
tSoltsol
iStepIndexistepindex
iIterIndexiiterindex
pTypeptype
eCompecomp
NXOpen::CAE::ResultMeasureResultOptions* NXOpen::CAE::ResultMeasureCollection::CreateResultOptionsNew ( NXOpen::CAE::SimSolution tSol,
NXOpen::CAE::SimResultReference tResultReference,
int  iStepIndex,
int  iIterIndex,
const NXOpen::CAE::Result::Type pType,
NXOpen::CAE::Result::Component  eComp 
)

Create a result options for result measure.

Returns

Deprecated:
Deprecated in NX11.0.0. Use NXOpen::CAE::Iteration :CreateNewResultOptions instead.


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
tSoltsol
tResultReferencetresultreference
iStepIndexistepindex
iIterIndexiiterindex
pTypeptype
eCompecomp
void NXOpen::CAE::ResultMeasureCollection::DeleteMeasures ( const std::vector< NXOpen::CAE::ResultMeasure * > &  objects)

Delete list of result measures
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
objectsThe objects to be updated
iterator NXOpen::CAE::ResultMeasureCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::Find ( const NXString journalIdentifier)

Finds the NXOpen::CAE::ResultMeasure with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
The found ResultMeasure
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
journalIdentifierIdentifier of the ResultMeasure you want
NXOpen::CAE::ResultMeasure* NXOpen::CAE::ResultMeasureCollection::Find ( const char *  journalIdentifier)

Finds the NXOpen::CAE::ResultMeasure with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
The found ResultMeasure
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
journalIdentifierIdentifier of the ResultMeasure you want
tag_t NXOpen::CAE::ResultMeasureCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::ResultMeasureCollection::UpdateMeasures ( const std::vector< NXOpen::CAE::ResultMeasure * > &  objects)

Update list of result measures.

Will open each measure's associated result file, and recompute requested value
Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
objectsThe objects to be updated

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