RSEvent Class¶
-
class
NXOpen.CAE.ResponseSimulation.
RSEvent
¶ Bases:
NXOpen.NXObject
Represents a response analysis event
To create or edit an instance of this class, use
NXOpen.CAE.ResponseSimulation.RSEventBuilder
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 |
---|---|
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 encountered with the given Type with option to update or not. |
Destroy | Deletes a response simulation dynamic event, including all excitations under it |
EvaluateCsd | Performs evaluation for CSD. |
EvaluateElementalFunctionResponse | Performs evaluation for elemental function response. |
EvaluateLcrResults | Performs evaluation for LCR results. |
EvaluateModalFunctionResponse | Performs evaluation for modal function response. |
EvaluateModalResponse | Performs evaluation for modal response. |
EvaluateNodalFunctionResponse | Performs evaluation for nodal function response. |
EvaluatePeakValueResults | Performs evaluation for peak value results. |
EvaluateResponseResults | Performs evaluation for response results. |
EvaluateRmsResults | Perfroms evaluation for RMS results. |
EvaluateSensorResponse | Performs evaluation for sensor response. |
EvaluateStrainGageResponse | Performs evaluation for strain gage response. |
EvaluateStrengthResults | Performs evaluation for strength results. |
Export | Exports event definition to a XML file |
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. |
GetCalculateStaticOffset | Returns the option setting for calculating static offset result. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetEventName | Returns the event name @return |
GetExcitations | Returns all excitations of an event @return |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
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 result file name of specified type @return |
GetSolverParameters | Returns the solver parameters @return |
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, of the given type. |
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. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
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. |
SetCalculateStaticOffset | Set the option setting for calculating static offset result. |
SetEventName | Sets the event name |
SetName | Sets the custom name of 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. |
Enumerations¶
RSEventAnalysisType Enumeration | the analysis type of response analysis event. |
RSEventDdamFormulationType Enumeration | Represents the fromulation type. |
RSEventDurationOption Enumeration | the duration option |
RSEventResultFileType Enumeration | the result file type of event. |
RSEventSpacingType Enumeration | the spacing type. |
RSEventType Enumeration | the type of reponse analysis event |
Property Detail¶
IsOccurrence¶
-
RSEvent.
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¶
-
RSEvent.
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¶
-
RSEvent.
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¶
-
RSEvent.
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¶
-
RSEvent.
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¶
-
RSEvent.
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¶
Destroy¶
-
RSEvent.
Destroy
¶ Deletes a response simulation dynamic event, including all 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”)
EvaluateCsd¶
-
RSEvent.
EvaluateCsd
¶ Performs evaluation for CSD.
The evaluation results will be stored in an AFU file, which name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateCsd(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.CsdEvaluationSetting
) –New in version NX6.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateElementalFunctionResponse¶
-
RSEvent.
EvaluateElementalFunctionResponse
¶ Performs evaluation for elemental function response.
The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateElementalFunctionResponse(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.ElementalFunctionEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateLcrResults¶
-
RSEvent.
EvaluateLcrResults
¶ Performs evaluation for LCR results.
The results is stored in an RS2 file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateLcrResults(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.LcrResultsEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateModalFunctionResponse¶
-
RSEvent.
EvaluateModalFunctionResponse
¶ Performs evaluation for modal function response.
The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateModalFunctionResponse()
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateModalResponse¶
-
RSEvent.
EvaluateModalResponse
¶ Performs evaluation for modal response.
The results is getting eef file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateModalResponse()
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateNodalFunctionResponse¶
-
RSEvent.
EvaluateNodalFunctionResponse
¶ Performs evaluation for nodal function response.
The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateNodalFunctionResponse(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.NodalFunctionEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluatePeakValueResults¶
-
RSEvent.
EvaluatePeakValueResults
¶ Performs evaluation for peak value results.
The results is stored in an RS2 file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
.Signature
EvaluatePeakValueResults(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.PeakValueEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateResponseResults¶
-
RSEvent.
EvaluateResponseResults
¶ Performs evaluation for response results.
The results is stored in an RS2 file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
.Signature
EvaluateResponseResults(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.ResponseResultsEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateRmsResults¶
-
RSEvent.
EvaluateRmsResults
¶ Perfroms evaluation for RMS results.
The results is stored in an RS2 file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
.Signature
EvaluateRmsResults(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.RmsResultsEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateSensorResponse¶
-
RSEvent.
EvaluateSensorResponse
¶ Overloaded method EvaluateSensorResponse
EvaluateSensorResponse()
EvaluateSensorResponse(evaluationSetting)
-------------------------------------
Performs evaluation for sensor response. The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateSensorResponse()
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
Performs evaluation for sensor response. The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateSensorResponse(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.SensorEvaluationSetting
) –New in version NX6.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
EvaluateStrainGageResponse¶
-
RSEvent.
EvaluateStrainGageResponse
¶ Performs evaluation for strain gage response.
The results is stored in an AFU file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
Signature
EvaluateStrainGageResponse(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.StrainGageEvaluationSetting
) –New in version NX6.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluateStrengthResults¶
-
RSEvent.
EvaluateStrengthResults
¶ Performs evaluation for strength results.
The results is stored in an RS2 file, which file name could be returned by
NXOpen.CAE.ResponseSimulation.RSEvent.GetResultFileName
.Signature
EvaluateStrengthResults(evaluationSetting)
Parameters: evaluationSetting ( NXOpen.CAE.ResponseSimulation.StrengthResultsEvaluationSetting
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Export¶
-
RSEvent.
Export
¶ Exports event definition to a XML file
Signature
Export(eventDefinitionFile)
Parameters: eventDefinitionFile (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
FindObject¶
-
RSEvent.
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.
GetCalculateStaticOffset¶
-
RSEvent.
GetCalculateStaticOffset
¶ Returns the option setting for calculating static offset result.
The staic offset calculation is only available to transient event
Signature
GetCalculateStaticOffset()
Returns: Return type: bool New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetEventName¶
-
RSEvent.
GetEventName
¶ Returns the event name
Signature
GetEventName()
Returns: Return type: str New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetExcitations¶
-
RSEvent.
GetExcitations
¶ Returns all excitations of an event
Signature
GetExcitations()
Returns: Return type: list of NXOpen.CAE.ResponseSimulation.Excitation
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetResultFileName¶
-
RSEvent.
GetResultFileName
¶ Returns result file name of specified type
Signature
GetResultFileName(resultFileType)
Parameters: resultFileType ( NXOpen.CAE.ResponseSimulation.RSEventResultFileType
) –Returns: Return type: str New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetSolverParameters¶
-
RSEvent.
GetSolverParameters
¶ Returns the solver parameters
Signature
GetSolverParameters()
Returns: Return type: NXOpen.CAE.ResponseSimulation.RSEventSolverParameters
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Print¶
-
RSEvent.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetCalculateStaticOffset¶
-
RSEvent.
SetCalculateStaticOffset
¶ Set the option setting for calculating static offset result.
The static offset calculation is only available to transient event
Signature
SetCalculateStaticOffset(calculateStaticOffset)
Parameters: calculateStaticOffset (bool) – New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
SetEventName¶
-
RSEvent.
SetEventName
¶ Sets the event name
Signature
SetEventName(eventName, renameResultFile)
Parameters: - eventName (str) – NOTE: The full Unicode character set is not supported for this parameter.
- renameResultFile (bool) – if there are result files associated with the event, rename them or not
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
SetName¶
-
RSEvent.
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.