NormalMode Class¶
-
class
NXOpen.CAE.ResponseSimulation.NormalMode¶ Bases:
NXOpen.NXObjectRepresents the properties of one normal mode
New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Active | Returns or sets the activate status |
| Hysteretic | Returns or sets the hysteretic factor |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Tag | Returns the Tag for this object. |
| Viscous | Returns or sets the viscous factor |
Methods¶
| Method | Description |
|---|---|
| CreateAttributeIterator | Create an attribute iterator |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
| DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetFrequency | Returns the natrual frequency of the normal mode |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetMass | Returns the mass of the normal mode |
| GetModeId | Returns mode ID |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| GetPhysicalHysteretic | Returns the physical hysteretic factor |
| GetPhysicalViscous | Returns the physical viscous factor |
| GetRealAttribute | Gets a real attribute by title. |
| GetRealUserAttribute | Gets a real attribute by Title and array Index. |
| GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
| GetRxMass | Returns the percent mass of Rx direction component |
| GetRyMass | Returns the percent mass of Ry direction component |
| GetRzMass | Returns the percent mass of Rz direction component |
| GetStiffeness | Returns the stiffeness of the normal mode |
| GetStringAttribute | Gets a string attribute value by title. |
| GetStringUserAttribute | Gets a string attribute by Title and array Index. |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
| GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
| GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
| GetUserAttributeLock | Determine the lock of the given attribute. |
| GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
| GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
| GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| GetXMass | Returns the percent mass of X direction component |
| GetYMass | Returns the percent mass of Y direction component |
| GetZMass | Returns the percent mass of Z direction component |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
| Prints a representation of this object to the system log file. | |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetName | Sets the custom name of the object. |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| SetTimeAttribute | Creates or modifies a time attribute. |
| SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
| SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
| SetUserAttributeLock | Lock or unlock the given attribute. |
Property Detail¶
Active¶
-
NormalMode.Active¶ Returns or sets the activate status
-------------------------------------Getter Method
Signature
ActiveReturns: Return type: bool New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
ActiveParameters: active (bool) – New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Hysteretic¶
-
NormalMode.Hysteretic¶ Returns or sets the hysteretic factor
-------------------------------------Getter Method
Signature
HystereticReturns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
HystereticParameters: hysteretic (float) – New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
IsOccurrence¶
-
NormalMode.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
NormalMode.JournalIdentifier¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------Getter Method
Signature
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
NormalMode.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
NormalMode.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
NormalMode.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
NormalMode.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Viscous¶
-
NormalMode.Viscous¶ Returns or sets the viscous factor
-------------------------------------Getter Method
Signature
ViscousReturns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
ViscousParameters: viscous (float) – New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
FindObject¶
-
NormalMode.FindObject¶ Finds the
NXOpen.NXObjectwith the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
GetFrequency¶
-
NormalMode.GetFrequency¶ Returns the natrual frequency of the normal mode
Signature
GetFrequency()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetMass¶
-
NormalMode.GetMass¶ Returns the mass of the normal mode
Signature
GetMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetModeId¶
-
NormalMode.GetModeId¶ Returns mode ID
Signature
GetModeId()Returns: Return type: int New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetPhysicalHysteretic¶
-
NormalMode.GetPhysicalHysteretic¶ Returns the physical hysteretic factor
Signature
GetPhysicalHysteretic()Returns: Return type: float New in version NX6.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetPhysicalViscous¶
-
NormalMode.GetPhysicalViscous¶ Returns the physical viscous factor
Signature
GetPhysicalViscous()Returns: Return type: float New in version NX6.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetRxMass¶
-
NormalMode.GetRxMass¶ Returns the percent mass of Rx direction component
Signature
GetRxMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetRyMass¶
-
NormalMode.GetRyMass¶ Returns the percent mass of Ry direction component
Signature
GetRyMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetRzMass¶
-
NormalMode.GetRzMass¶ Returns the percent mass of Rz direction component
Signature
GetRzMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetStiffeness¶
-
NormalMode.GetStiffeness¶ Returns the stiffeness of the normal mode
Signature
GetStiffeness()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetXMass¶
-
NormalMode.GetXMass¶ Returns the percent mass of X direction component
Signature
GetXMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetYMass¶
-
NormalMode.GetYMass¶ Returns the percent mass of Y direction component
Signature
GetYMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetZMass¶
-
NormalMode.GetZMass¶ Returns the percent mass of Z direction component
Signature
GetZMass()Returns: Return type: float New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Print¶
-
NormalMode.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
NormalMode.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.