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

This is the class representing a Mode set. More...

Inheritance diagram for NXOpen::CAE::ModeSet:
NXOpen::CAE::AlternateFemRepresentationSource NXOpen::CAE::IPostScenarioDataSource NXOpen::TaggedObject

Public Member Functions

void GetModeByIndex (int index, int *label, bool *status, double *undampedFrequency, double *dampingRatio, double *modalMassReal, double *modalMassImg, NXString *annotation)
 Get the data of a mode. More...
 
int GetNumberOfModes ()
 Get the number of modes. More...
 
void SetModeAnnotation (int index, const NXString &annotation)
 Modify the annotation of a mode. More...
 
void SetModeAnnotation (int index, const char *annotation)
 Modify the annotation of a mode. More...
 
void SetModeDampingRatio (int index, double dampingRatio)
 Modify the damping ratio of a mode. More...
 
void SetModeModalMass (int index, double modalMassReal, double modalMassImg)
 Modify the modal mass of a mode. More...
 
void SetModeStatus (int index, bool status)
 Modify the status of a mode. More...
 
void SetModeUndampedFrequency (int index, double undampedFrequency)
 Modify the undamped frequency of a mode. More...
 
- Public Member Functions inherited from NXOpen::CAE::AlternateFemRepresentationSource
void ForceUpdate ()
 Force update of the Alternate Fem Representation Source
Created in NX12.0.0. More...
 
void Rename (const NXString &name)
 Set the name of the Alternate Fem Representation Source
Created in NX12.0.0. More...
 
void Rename (const char *name)
 Set the name of the Alternate Fem Representation Source
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::CAE::AlternateFemRepresentationSource
enum  CreateMeshMode { CreateMeshModeAllElements, CreateMeshModeDataElements, CreateMeshModeVisualizationElements }
 Create mesh options. More...
 

Detailed Description

This is the class representing a Mode set.


Not support KF.

Created in NX12.0.0.

Member Function Documentation

void NXOpen::CAE::ModeSet::GetModeByIndex ( int  index,
int *  label,
bool *  status,
double *  undampedFrequency,
double *  dampingRatio,
double *  modalMassReal,
double *  modalMassImg,
NXString annotation 
)

Get the data of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
labelthe label of the mode
statusthe status of the mode
undampedFrequencythe undamped frequency of the mode
dampingRatiothe damping ratio of the mode
modalMassRealthe real part of the modal mass of the mode
modalMassImgthe imaginary part of the modal mass of the mode
annotationthe annotation of the mode
int NXOpen::CAE::ModeSet::GetNumberOfModes ( )

Get the number of modes.

Returns
The number of modes.
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")
void NXOpen::CAE::ModeSet::SetModeAnnotation ( int  index,
const NXString annotation 
)

Modify the annotation of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
annotationthe annotation of the mode
void NXOpen::CAE::ModeSet::SetModeAnnotation ( int  index,
const char *  annotation 
)

Modify the annotation of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
annotationthe annotation of the mode
void NXOpen::CAE::ModeSet::SetModeDampingRatio ( int  index,
double  dampingRatio 
)

Modify the damping ratio of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
dampingRatiothe damping ratio of the mode
void NXOpen::CAE::ModeSet::SetModeModalMass ( int  index,
double  modalMassReal,
double  modalMassImg 
)

Modify the modal mass of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
modalMassRealthe real part of the modal mass of the mode
modalMassImgthe imaginary part of the modal mass of the mode
void NXOpen::CAE::ModeSet::SetModeStatus ( int  index,
bool  status 
)

Modify the status of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
statusthe status of the mode
void NXOpen::CAE::ModeSet::SetModeUndampedFrequency ( int  index,
double  undampedFrequency 
)

Modify the undamped frequency of a mode.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode
undampedFrequencythe undamped frequency of the mode

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