NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | 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 NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _ModeInfo
 Struct for output parameters of get_mode_by_index
 
struct  ModeInfo
 Struct for output parameters of get_mode_by_index More...
 

Public Member Functions

unsafe void GetModeByIndex (int index, out int label, out bool status, out double undampedFrequency, out double dampingRatio, out double modalMassReal, out double modalMassImg, out string annotation)
 Get the data of a mode. More...
 
unsafe NXOpen.CAE.ModeSet.ModeInfo GetModeInfoByIndex (int index)
 Get the data of a mode. More...
 
unsafe int GetNumberOfModes ()
 Get the number of modes. More...
 
unsafe void SetModeAnnotation (int label, string annotation)
 Modify the annotation of a mode in the main data source. More...
 
unsafe void SetModeAnnotation (string dataSourceName, int label, string annotation)
 Modify the annotation of a mode in the specified data source. More...
 
unsafe void SetModeDampingRatio (int label, double dampingRatio)
 Modify the damping ratio of a mode in the main data source. More...
 
unsafe void SetModeDampingRatio (string dataSourceName, int label, double dampingRatio)
 Modify the damping ratio of a mode in the specified data source. More...
 
unsafe void SetModeModalMass (int label, double modalMassReal, double modalMassImg)
 Modify the modal mass of a mode in the main data source. More...
 
unsafe void SetModeModalMass (string dataSourceName, int label, double modalMassReal, double modalMassImg)
 Modify the modal mass of a mode. More...
 
unsafe void SetModeStatus (int label, bool status)
 Modify the status of a mode in the main data source. More...
 
unsafe void SetModeStatus (string dataSourceName, int label, bool status)
 Modify the status of a mode in the specified data source. More...
 
unsafe void SetModeUndampedFrequency (int label, double undampedFrequency)
 Modify the undamped frequency of a mode in the main data source. More...
 
unsafe void SetModeUndampedFrequency (string dataSourceName, int label, double undampedFrequency)
 Modify the undamped frequency of a mode in the specified data source. More...
 
- Public Member Functions inherited from NXOpen.CAE.AlternateFemRepresentationSource
unsafe void ClearNamedNodes ()
 Clears all the named nodes of an Alternate Fem Representation Source More...
 
unsafe void CreateCoordinateSelectionRecipes (bool updateExistingRecipes, NXOpen.TaggedObject componentTag, double tolerance, NXOpen.CAE.SelRecipeCoordinateStrategy.Pref resolvePreference)
 Creates one NXOpen.CAE.CoordinateSelectionRecipe for each node in the mapping having associated data. More...
 
unsafe void CreateSingleLabelSelectionRecipes (bool updateExistingRecipes, NXOpen.TaggedObject componentTag)
 Creates one NXOpen.CAE.SingleLabelSelectionRecipe for each node in the mapping having associated data. More...
 
unsafe void ForceUpdate ()
 Force update of the Alternate Fem Representation Source More...
 
unsafe void GetAltRepSelectionRecipes (out NXOpen.CAE.FEModelOccurrence[] pptFeModelOccTags, out NXOpen.CAE.SelectionRecipe[] pppSelectionRecipe)
 Gets the NXOpen.CAE.SelectionRecipe array in an Alternate Fem Representation Source and the corresponding replaced NXOpen.CAE.FEModelOccurrence array More...
 
unsafe NXOpen.CAE.SelectionRecipe[] GetMappedSelectionRecipes (NXOpen.CAE.FEModelOccurrence feModelOccTag)
 Gets the mapped NXOpen.CAE.SelectionRecipe array in an Alternate Fem Representation Source for the given NXOpen.CAE.FEModelOccurrence More...
 
unsafe
NXOpen.CAE.AlternateFemRepresentationSource.NameLabelPair[] 
GetNamedNodesWithLabel ()
 Gets the named nodes in an Alternate Fem Representation Source having no mappings More...
 
unsafe
NXOpen.CAE.AlternateFemRepresentationSource.NameIdentifierPair[] 
GetNamedNodesWithNodeId ()
 Gets the named nodes in an Alternate Fem Representation Source having mappings More...
 
unsafe
NXOpen.CAE.AlternateFemRepresentationSource.NameLabelPair[] 
GetNodeIdMappings ()
 Gets the mappings between a node string identifier and the correspondig node label. More...
 
unsafe
NXOpen.CAE.FEModelOccurrence[] 
GetReplacedFeModelOccs ()
 Gets the Finite Element Model Occurrences replaced by the Alternate Fem Representation Source More...
 
unsafe bool HasNodeIdMappings ()
 Returns true if the given Alternate Fem Representation Source has node string identifiers to labels mappings, i. More...
 
unsafe void Information (bool showWarnings)
 Shows in the info window the information about the Alternate Fem Representation Source. More...
 
unsafe void InsertNamedNodeWithLabel (string recipeNameString, int nodeLabel)
 Adds or replaces a named node in an Alternate Fem Representation Source having no mappings. More...
 
unsafe void InsertNamedNodeWithNodeId (string recipeNameString, string nodeIDString)
 Adds or replaces a named node in an Alternate Fem Representation Source having mappings. More...
 
unsafe void InsertSelectionRecipeMappingWithLabel (NXOpen.CAE.FEModelOccurrence feModelOccTag, NXOpen.CAE.SelectionRecipe pSelectionRecipe, int nodeLabel)
 Adds or replaces a NXOpen.CAE.SelectionRecipe for the given replaced NXOpen.CAE.FEModelOccurrence in an Alternate Fem Representation Source without mappings More...
 
unsafe void InsertSelectionRecipeMappingWithNodeId (NXOpen.CAE.FEModelOccurrence feModelOccTag, NXOpen.CAE.SelectionRecipe pSelectionRecipe, string nodeIDString)
 Adds or replaces a NXOpen.CAE.SelectionRecipe for the given replaced NXOpen.CAE.FEModelOccurrence in an Alternate Fem Representation Source having mappings More...
 
unsafe void RemoveSelectionRecipeMapping (NXOpen.CAE.FEModelOccurrence feModelOccTag, NXOpen.CAE.SelectionRecipe pSelectionRecipe)
 Removes a NXOpen.CAE.SelectionRecipe for the given replaced NXOpen.CAE.FEModelOccurrence from the Alternate Fem Representation Source More...
 
unsafe void Rename (string name)
 Set the name of the Alternate Fem Representation Source 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...
 

Additional Inherited Members

- Public Types inherited from NXOpen.CAE.AlternateFemRepresentationSource
enum  CreateMeshMode { AllElements, DataElements, VisualizationElements }
 Create mesh options More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.CAE.AlternateFemRepresentationSource
unsafe NXOpen.BasePropertyTable PropertyTable [get]
 Returns the NXOpen.BasePropertyTable of the Alternate Fem Representation Source. More...
 

Detailed Description

This is the class representing a Mode set.

Not support KF.

Created in NX12.0.0

Member Function Documentation

unsafe void NXOpen.CAE.ModeSet.GetModeByIndex ( int  index,
out int  label,
out bool  status,
out double  undampedFrequency,
out double  dampingRatio,
out double  modalMassReal,
out double  modalMassImg,
out string  annotation 
)
inline

Get the data of a mode.

Created in NX12.0.0

Deprecated in NX1872.0.0. Use GetModeInfoByIndex instead.

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
unsafe NXOpen.CAE.ModeSet.ModeInfo NXOpen.CAE.ModeSet.GetModeInfoByIndex ( int  index)
inline

Get the data of a mode.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
indexthe index of the mode within the mode set
Returns
the output structure containing all the mode info
unsafe int NXOpen.CAE.ModeSet.GetNumberOfModes ( )
inline

Get the number of modes.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
The number of modes.
unsafe void NXOpen.CAE.ModeSet.SetModeAnnotation ( int  label,
string  annotation 
)
inline

Modify the annotation of a mode in the main data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
labelthe label of the mode
annotationthe annotation of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeAnnotation ( string  dataSourceName,
int  label,
string  annotation 
)
inline

Modify the annotation of a mode in the specified data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dataSourceNamethe data source name of the mode
labelthe label of the mode
annotationthe annotation of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeDampingRatio ( int  label,
double  dampingRatio 
)
inline

Modify the damping ratio of a mode in the main data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
labelthe label of the mode
dampingRatiothe damping ratio of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeDampingRatio ( string  dataSourceName,
int  label,
double  dampingRatio 
)
inline

Modify the damping ratio of a mode in the specified data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dataSourceNamethe data source name of the mode
labelthe label of the mode
dampingRatiothe damping ratio of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeModalMass ( int  label,
double  modalMassReal,
double  modalMassImg 
)
inline

Modify the modal mass of a mode in the main data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
labelthe label of the mode
modalMassRealthe real part of the modal mass of the mode
modalMassImgthe imaginary part of the modal mass of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeModalMass ( string  dataSourceName,
int  label,
double  modalMassReal,
double  modalMassImg 
)
inline

Modify the modal mass of a mode.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dataSourceNamethe data source name of the mode
labelthe label of the mode
modalMassRealthe real part of the modal mass of the mode
modalMassImgthe imaginary part of the modal mass of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeStatus ( int  label,
bool  status 
)
inline

Modify the status of a mode in the main data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
labelthe label of the mode
statusthe status of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeStatus ( string  dataSourceName,
int  label,
bool  status 
)
inline

Modify the status of a mode in the specified data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dataSourceNamethe data source name of the mode
labelthe label of the mode
statusthe status of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeUndampedFrequency ( int  label,
double  undampedFrequency 
)
inline

Modify the undamped frequency of a mode in the main data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
labelthe label of the mode
undampedFrequencythe undamped frequency of the mode
unsafe void NXOpen.CAE.ModeSet.SetModeUndampedFrequency ( string  dataSourceName,
int  label,
double  undampedFrequency 
)
inline

Modify the undamped frequency of a mode in the specified data source.

This method should be followed by a subsequent call to NXOpen.Update.DoUpdate . If your application sets multiple information to the mode set, then NXOpen.Update.DoUpdate should be called only once after setting all the new information of the mode set.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
dataSourceNamethe data source name of the mode
labelthe label of the mode
undampedFrequencythe undamped frequency of the mode

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