NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.BaseIteration Class Reference

This class provides interfaces to query iteration attributes More...

Inheritance diagram for NXOpen.CAE.BaseIteration:
NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.CAE.Iteration

Public Types

enum  IterationType {
  Unknown = -1, Static, Mode, ConstraintMode,
  Transient, Buckling, Nonlinear, FrequencyResponse
}
 The Analysis type of a iteration object More...
 
enum  IterationValueType {
  Unknown = -1, Time, Frequency, LoadFactor,
  Eigenvalue, Harmonic, RotationSpeed, DesignCycle,
  Acoustic, BoltSequence, AeroMode
}
 The type of value that is stored in a iteration object More...
 

Public Member Functions

unsafe NXOpen.TaggedObject Find (string journalIdentifier)
 Returns a NXOpen.CAE.BaseResultType More...
 
unsafe NXOpen.CAE.BaseResultType[] GetResultTypes ()
 Returns the result types present in this iteration More...
 
unsafe NXOpen.CAE.BaseIteration[] GetSubIterations ()
 Returns the sub iterations present in this iteration More...
 
unsafe NXOpen.Unit GetUnitOfType (NXOpen.CAE.BaseIteration.IterationValueType valueType)
 The unit for the iteration type More...
 
unsafe double GetValueOfType (NXOpen.CAE.BaseIteration.IterationValueType valueType)
 The iteration value of iteration type More...
 
unsafe void GetValueTypes (out NXOpen.CAE.BaseIteration.IterationValueType[] valueType)
 The array of iteration value types More...
 
unsafe bool HasModalMass ()
 Whether this modal iteration has any mass value More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe double ModalMass [get]
 Returns the method returns mass value of this modal iteration More...
 
unsafe string Name [get]
 Returns the name of the iteration More...
 
unsafe
NXOpen.CAE.BaseIteration.IterationType 
Type [get]
 Returns the type of the iteration More...
 
unsafe NXOpen.Unit Unit [get]
 Returns the units for the iteration value More...
 
unsafe double Value [get]
 Returns the iteration value More...
 
unsafe
NXOpen.CAE.BaseIteration.IterationValueType 
ValueType [get]
 Returns the iteration value type More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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
Unknown 

Iteration has an Unknown type

Static 

Static Analysis Iteration

Mode 

Modal Analysis Iteration

ConstraintMode 

Constraint Modal Analysis Iteration

Transient 

Transient Analysis Iteration

Buckling 

Buckling Analysis Iteration

Nonlinear 

NonLinear Analysis Iteration

FrequencyResponse 

Frequency Response Analysis Iteration

The type of value that is stored in a iteration object

Enumerator
Unknown 

Value has an Unknown type

Time 

Value represents a Time

Frequency 

Value represents a Frequency

LoadFactor 

Value represents a LoadFactor

Eigenvalue 

Value represents a Eigenvalue

Harmonic 

Value represents a Harmonic

RotationSpeed 

Value represents a RotationSpeed

DesignCycle 

Value represents a DesignCycle

Acoustic 

Value represents a Acoustic Mode

BoltSequence 

Value represents a Bolt Sequence

AeroMode 

Value represents a Aero Mode

Member Function Documentation

unsafe NXOpen.TaggedObject NXOpen.CAE.BaseIteration.Find ( string  journalIdentifier)
inline

Returns a NXOpen.CAE.BaseResultType

Created in NX7.5.0

License requirements: None.

Parameters
journalIdentifierJournal identifier of the object
Returns
unsafe NXOpen.CAE.BaseResultType [] NXOpen.CAE.BaseIteration.GetResultTypes ( )
inline

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

Returns
unsafe NXOpen.CAE.BaseIteration [] NXOpen.CAE.BaseIteration.GetSubIterations ( )
inline

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

Returns
unsafe NXOpen.Unit NXOpen.CAE.BaseIteration.GetUnitOfType ( NXOpen.CAE.BaseIteration.IterationValueType  valueType)
inline

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
Returns
unsafe double NXOpen.CAE.BaseIteration.GetValueOfType ( NXOpen.CAE.BaseIteration.IterationValueType  valueType)
inline

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
Returns
unsafe void NXOpen.CAE.BaseIteration.GetValueTypes ( out NXOpen.CAE.BaseIteration.IterationValueType[]  valueType)
inline

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
unsafe bool NXOpen.CAE.BaseIteration.HasModalMass ( )
inline

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

Returns

Property Documentation

unsafe double NXOpen.CAE.BaseIteration.ModalMass
get

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

unsafe string NXOpen.CAE.BaseIteration.Name
get

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

unsafe NXOpen.CAE.BaseIteration.IterationType NXOpen.CAE.BaseIteration.Type
get

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

unsafe NXOpen.Unit NXOpen.CAE.BaseIteration.Unit
get

Returns the units for the iteration value

Created in NX7.5.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.BaseIteration.GetUnitOfType instead.

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

unsafe double NXOpen.CAE.BaseIteration.Value
get

Returns the iteration value

Created in NX7.5.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.BaseIteration.GetValueOfType instead.

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

unsafe NXOpen.CAE.BaseIteration.IterationValueType NXOpen.CAE.BaseIteration.ValueType
get

Returns the iteration value type

Created in NX7.5.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.BaseIteration.GetValueTypes instead.

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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.