NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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:
NXOpen::TaggedObject NXOpen::CAE::Iteration

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
}
 The type of value that is stored in a iteration object. More...
 

Public Member Functions

NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Returns a NXOpen::CAE::BaseResultType. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Returns a NXOpen::CAE::BaseResultType. More...
 
std::vector
< NXOpen::CAE::BaseResultType * > 
GetResultTypes ()
 Returns the result types present in this iteration. 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::UnitUnit ()
 Returns the units for the iteration value
Created in NX7.5.0. More...
 
double Value ()
 Returns the iteration value
Created in NX7.5.0. More...
 
NXOpen::CAE::BaseIteration::IterationValueType ValueType ()
 Returns the iteration value type
Created in NX7.5.0. 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

The Analysis type of a iteration object.

Enumerator
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.

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

Enumerator
IterationValueTypeTime 

Value represents a Time.

IterationValueTypeFrequency 

Value represents a Frequency.

IterationValueTypeLoadFactor 

Value represents a LoadFactor.

IterationValueTypeEigenvalue 

Value represents a Eigenvalue.

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
journalIdentifierJournal 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
journalIdentifierJournal identifier of the object
std::vector<NXOpen::CAE::BaseResultType *> NXOpen::CAE::BaseIteration::GetResultTypes ( )

Returns the result types present in this iteration.

Returns

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
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")

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")

NXOpen::Unit* NXOpen::CAE::BaseIteration::Unit ( )

Returns the units for the iteration value
Created in NX7.5.0.



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

double NXOpen::CAE::BaseIteration::Value ( )

Returns the iteration value
Created in NX7.5.0.



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

NXOpen::CAE::BaseIteration::IterationValueType NXOpen::CAE::BaseIteration::ValueType ( )

Returns the iteration value type
Created in NX7.5.0.



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


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