NXOpen::CAE::BaseIteration Class Reference

This class provides interfaces to query iteration attributes
An instance of this class can not be obtained

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::CAE::BaseIteration:

Public Types
enum	IterationType {   IterationTypeUnknown = -1, IterationTypeStatic, IterationTypeMode, IterationTypeConstraintMode,   IterationTypeTransient, IterationTypeBuckling, IterationTypeNonlinear, IterationTypeFrequencyResponse }
	The Analysis type of a iteration object. More...
enum	IterationValueType {   IterationValueTypeUnknown = -1, IterationValueTypeTime, IterationValueTypeFrequency, IterationValueTypeLoadFactor,   IterationValueTypeEigenvalue, IterationValueTypeHarmonic, IterationValueTypeRotationSpeed, IterationValueTypeDesignCycle,   IterationValueTypeAcoustic, IterationValueTypeBoltSequence }
	The type of value that is stored in a iteration object. More...

Public Member Functions
NXOpen::TaggedObject *	Find (const NXString &journalIdentifier)
	Returns a NXOpen::CAE::BaseResultType. More...
NXOpen::TaggedObject *	Find (const char *journalIdentifier)
	Returns a NXOpen::CAE::BaseResultType. More...
std::vector < NXOpen::CAE::BaseResultType * >	GetResultTypes ()
	Returns the result types present in this iteration Created in NX7.5.0. More...
std::vector < NXOpen::CAE::BaseIteration * >	GetSubIterations ()
	Returns the sub iterations present in this iteration Created in NX11.0.0. More...
NXOpen::Unit *	GetUnitOfType (NXOpen::CAE::BaseIteration::IterationValueType valueType)
	The unit for the iteration type Created in NX1847.0.0. More...
double	GetValueOfType (NXOpen::CAE::BaseIteration::IterationValueType valueType)
	The iteration value of iteration type Created in NX1847.0.0. More...
void	GetValueTypes (std::vector< NXOpen::CAE::BaseIteration::IterationValueType > &valueType)
	The array of iteration value types Created in NX1847.0.0. More...
bool	HasModalMass ()
	Whether this modal iteration has any mass value Created in NX11.0.2. More...
double	ModalMass ()
	Returns the method returns mass value of this modal iteration Created in NX11.0.2. More...
NXString	Name ()
	Returns the name of the iteration Created in NX7.5.0. More...
NXOpen::CAE::BaseIteration::IterationType	Type ()
	Returns the type of the iteration Created in NX7.5.0. More...
NXOpen::Unit *	Unit ()
	Returns the units for the iteration value More...
double	Value ()
	Returns the iteration value More...
NXOpen::CAE::BaseIteration::IterationValueType	ValueType ()
	Returns the iteration value type More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

This class provides interfaces to query iteration attributes
An instance of this class can not be obtained

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::CAE::BaseIteration::IterationType

The Analysis type of a iteration object.

Enumerator
IterationTypeUnknown	Iteration has an Unknown type.
IterationTypeStatic	Static Analysis Iteration.
IterationTypeMode	Modal Analysis Iteration.
IterationTypeConstraintMode	Constraint Modal Analysis Iteration.
IterationTypeTransient	Transient Analysis Iteration.
IterationTypeBuckling	Buckling Analysis Iteration.
IterationTypeNonlinear	NonLinear Analysis Iteration.
IterationTypeFrequencyResponse	Frequency Response Analysis Iteration.

enum NXOpen::CAE::BaseIteration::IterationValueType

The type of value that is stored in a iteration object.

Enumerator
IterationValueTypeUnknown	Value has an Unknown type.
IterationValueTypeTime	Value represents a Time.
IterationValueTypeFrequency	Value represents a Frequency.
IterationValueTypeLoadFactor	Value represents a LoadFactor.
IterationValueTypeEigenvalue	Value represents a Eigenvalue.
IterationValueTypeHarmonic	Value represents a Harmonic.
IterationValueTypeRotationSpeed	Value represents a RotationSpeed.
IterationValueTypeDesignCycle	Value represents a DesignCycle.
IterationValueTypeAcoustic	Value represents a Acoustic Mode.
IterationValueTypeBoltSequence	Value represents a Bolt Sequence.

Member Function Documentation

NXOpen::TaggedObject* NXOpen::CAE::BaseIteration::Find

(

const NXString &

journalIdentifier

)

Returns a NXOpen::CAE::BaseResultType.

Returns

Created in NX7.5.0.

License requirements : None

Parameters

journalIdentifier

Journal identifier of the object

NXOpen::TaggedObject* NXOpen::CAE::BaseIteration::Find

(

const char *

journalIdentifier

)

Returns a NXOpen::CAE::BaseResultType.

Returns

Created in NX7.5.0.

License requirements : None

Parameters

journalIdentifier

Journal identifier of the object

std::vector<NXOpen::CAE::BaseResultType *> NXOpen::CAE::BaseIteration::GetResultTypes

(

)

Returns the result types present in this iteration
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

std::vector<NXOpen::CAE::BaseIteration *> NXOpen::CAE::BaseIteration::GetSubIterations

(

)

Returns the sub iterations present in this iteration
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::Unit* NXOpen::CAE::BaseIteration::GetUnitOfType

(

NXOpen::CAE::BaseIteration::IterationValueType

valueType

)

The unit for the iteration type
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters

valueType

valuetype

double NXOpen::CAE::BaseIteration::GetValueOfType

(

NXOpen::CAE::BaseIteration::IterationValueType

valueType

)

The iteration value of iteration type
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters

valueType

valuetype

void NXOpen::CAE::BaseIteration::GetValueTypes

(

std::vector< NXOpen::CAE::BaseIteration::IterationValueType > &

valueType

)

The array of iteration value types
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters

valueType

valuetype

bool NXOpen::CAE::BaseIteration::HasModalMass

(

)

Whether this modal iteration has any mass value
Created in NX11.0.2.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

double NXOpen::CAE::BaseIteration::ModalMass

(

)

Returns the method returns mass value of this modal iteration
Created in NX11.0.2.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXString NXOpen::CAE::BaseIteration::Name

(

)

Returns the name of the iteration
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::BaseIteration::IterationType NXOpen::CAE::BaseIteration::Type

(

)

Returns the type of the iteration
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::Unit* NXOpen::CAE::BaseIteration::Unit

(

)

Returns the units for the iteration value

Deprecated:

Deprecated in NX1847.0.0.

Use NXOpen::CAE::BaseIteration::GetUnitOfType instead.

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

double NXOpen::CAE::BaseIteration::Value

(

)

Returns the iteration value

Deprecated:

Deprecated in NX1847.0.0.

Use NXOpen::CAE::BaseIteration::GetValueOfType instead.

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::BaseIteration::IterationValueType NXOpen::CAE::BaseIteration::ValueType

(

)

Returns the iteration value type

Deprecated:

Deprecated in NX1847.0.0.

Use NXOpen::CAE::BaseIteration::GetValueTypes instead.

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

---

The documentation for this class was generated from the following file:

• CAE_BaseIteration.hxx