Solution Class

class NXOpen.CAE.ResponseSimulation.Solution

Bases: NXOpen.NXObject

Represents a meta solution providing response analysis functionalities in the .

sim file To create or edit an instance of this class, use NXOpen.CAE.ResponseSimulation.SolutionBuilder

New in version NX5.0.0.

Properties

Property Description
ActiveEvent Returns or sets the active event
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
CheckObsoleteStatus Checks status and updates solution properties for the solution which became obsolete because referenced modal shape file was changed.
CloneEvent Clones an event to the solution
CloneSensor Clones a sensor to the solution
CloneStrainGage Clones a strain gage to the solution
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
Destroy Deletes a response simulation solution, including all events and excitations under it
EvaluateFrf Performs evaluation for FRF.
EvaluateTransmissibility Performs evaluation for transimissibility.
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.
GetEvaluationParameters Returns the evaluation parameters of Response Analysis Meta solution
GetEvents Returns all the events of the solution
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetModalProperties Returns the modal properties of Response Analysis Meta solution
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.
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.
GetResultFileName Returns the result file name of solution
GetSolutionName Returns the response simulation solution name
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
ImportEvent Imports an event to the solution
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.
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.
SetSolutionName Sets the response simulation solution name
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

ActiveEvent

Solution.ActiveEvent

Returns or sets the active event

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

Getter Method

Signature ActiveEvent

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature ActiveEvent

Parameters:activeEvent (NXOpen.CAE.ResponseSimulation.RSEvent) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

IsOccurrence

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

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

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

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

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

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

CheckObsoleteStatus

Solution.CheckObsoleteStatus

Checks status and updates solution properties for the solution which became obsolete because referenced modal shape file was changed.

The solution will be reactivated as normal state after status checking.

Signature CheckObsoleteStatus()

New in version NX8.0.1.

License requirements: nx_response_anlys (“NX Response Analysis”)

CloneEvent

Solution.CloneEvent

Clones an event to the solution

Signature CloneEvent(sourceEvent, suggestedName)

Parameters:
Returns:
Return type:

NXOpen.CAE.ResponseSimulation.RSEvent

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

CloneSensor

Solution.CloneSensor

Clones a sensor to the solution

Signature CloneSensor(sourceSensor, suggestedName)

Parameters:
Returns:
Return type:

NXOpen.CAE.ResponseSimulation.Sensor

New in version NX5.0.1.

License requirements: nx_response_anlys (“NX Response Analysis”)

CloneStrainGage

Solution.CloneStrainGage

Clones a strain gage to the solution

Signature CloneStrainGage(sourceGage, suggestedName)

Parameters:
Returns:
Return type:

NXOpen.CAE.ResponseSimulation.StrainGage

New in version NX5.0.1.

License requirements: nx_response_anlys (“NX Response Analysis”)

Destroy

Solution.Destroy

Deletes a response simulation solution, including all events and excitations under it

Signature Destroy(deleteResultFile)

Parameters:deleteResultFile (bool) – delete the result files associated with the solution or not

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

EvaluateFrf

Solution.EvaluateFrf

Performs evaluation for FRF.

The evaluation results will be stored in an AFU file, which name could be returned by NXOpen.CAE.ResponseSimulation.Solution.GetResultFileName()

Signature EvaluateFrf(evaluationSetting)

Parameters:evaluationSetting (NXOpen.CAE.ResponseSimulation.FrfEvaluationSetting) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

EvaluateTransmissibility

Solution.EvaluateTransmissibility

Performs evaluation for transimissibility.

The evaluation results will be stored in an AFU file, which name could be returned by NXOpen.CAE.ResponseSimulation.Solution.GetResultFileName()

Signature EvaluateTransmissibility(evaluationSetting)

Parameters:evaluationSetting (NXOpen.CAE.ResponseSimulation.TransmissibilityEvaluationSetting) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

FindObject

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

GetEvaluationParameters

Solution.GetEvaluationParameters

Returns the evaluation parameters of Response Analysis Meta solution

Signature GetEvaluationParameters()

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

New in version NX6.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetEvents

Solution.GetEvents

Returns all the events of the solution

Signature GetEvents()

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetModalProperties

Solution.GetModalProperties

Returns the modal properties of Response Analysis Meta solution

Signature GetModalProperties()

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetResultFileName

Solution.GetResultFileName

Returns the result file name of solution

Signature GetResultFileName()

Returns:
Return type:str

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetSolutionName

Solution.GetSolutionName

Returns the response simulation solution name

Signature GetSolutionName()

Returns:
Return type:str

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

ImportEvent

Solution.ImportEvent

Imports an event to the solution

Signature ImportEvent(eventDefinitionFile, suggestedName)

Parameters:
  • eventDefinitionFile (str) –
  • suggestedName (str) –
Returns:
Return type:

NXOpen.CAE.ResponseSimulation.RSEvent

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Print

Solution.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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

SetSolutionName

Solution.SetSolutionName

Sets the response simulation solution name

Signature SetSolutionName(solutionName, renameResultFile)

Parameters:
  • solutionName (str) –
  • renameResultFile (bool) – if there are result files associated with the solution, rename the files or not

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)