ModalProperties Class

class NXOpen.CAE.ResponseSimulation.ModalProperties

Bases: NXOpen.NXObject

Represents the modal presentation of a response analysis meta solution

New in version NX5.0.0.

Properties

Property	Description
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.

Methods

Method	Description
Activate	Sets activate or deactivate status for all normal modes
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.
GetAttachmentModeCount	Returns the count of attachment modes
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.
GetConstrainModeCount	Returns the count of constrain modes
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNormalModeById	Returns normal mode with specified node ID
GetNormalModeCount	Returns the count of normal modes
GetNormalModes	Returns all normal modes
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetPhysicalDampingSettings	Returns the physical damping setting object
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.
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.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	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.
SetDampingFactors	Set damping factors for all normal modes
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetRayleighDamping	Set rayleigh’s damping for all normal modes
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

IsOccurrence

ModalProperties.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

ModalProperties.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 JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

ModalProperties.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

ModalProperties.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ModalProperties.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

ModalProperties.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

Activate

ModalProperties.Activate

Sets activate or deactivate status for all normal modes

Signature Activate(activate)

Parameters:activate (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

FindObject

ModalProperties.FindObject

Finds the NXOpen.NXObject with 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.INXObject

New in version NX3.0.0.

License requirements: None.

GetAttachmentModeCount

ModalProperties.GetAttachmentModeCount

Returns the count of attachment modes

Signature GetAttachmentModeCount()

Returns: Return type:int

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetConstrainModeCount

ModalProperties.GetConstrainModeCount

Returns the count of constrain modes

Signature GetConstrainModeCount()

Returns: Return type:int

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetNormalModeById

ModalProperties.GetNormalModeById

Returns normal mode with specified node ID

Signature GetNormalModeById(modeId)

Parameters:modeId (int) – Returns: Return type:NXOpen.CAE.ResponseSimulation.NormalMode

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetNormalModeCount

ModalProperties.GetNormalModeCount

Returns the count of normal modes

Signature GetNormalModeCount()

Returns: Return type:int

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetNormalModes

ModalProperties.GetNormalModes

Returns all normal modes

Signature GetNormalModes()

Returns: Return type:list of NXOpen.CAE.ResponseSimulation.NormalMode

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetPhysicalDampingSettings

ModalProperties.GetPhysicalDampingSettings

Returns the physical damping setting object

Signature GetPhysicalDampingSettings()

Returns: Return type:NXOpen.CAE.ResponseSimulation.PhysicalDampingSettings

New in version NX6.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Print

ModalProperties.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetDampingFactors

ModalProperties.SetDampingFactors

Set damping factors for all normal modes

Signature SetDampingFactors(viscousDamping, hystereticDamping)

Parameters:

• viscousDamping (float) –
• hystereticDamping (float) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SetName

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

SetRayleighDamping

ModalProperties.SetRayleighDamping

Set rayleigh’s damping for all normal modes

Signature SetRayleighDamping(alphaFactor, beltaFactor)

Parameters:

• alphaFactor (float) –
• beltaFactor (float) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)