PeakValueEvaluationSettingBuilder Class

class NXOpen.CAE.ResponseSimulation.PeakValueEvaluationSettingBuilder

Bases: NXOpen.CAE.ResponseSimulation.PrlResultsEvaluationSettingBuilder

This is a manager to the NXOpen.CAE.ResponseSimulation.PeakValueEvaluationSetting class.

Object of type NXOpen.CAE.ResponseSimulation.PeakValueEvaluationSetting can be created and edited only through this class

To create a new instance of this class, use NXOpen.CAE.ResponseSimulation.EvaluationSettingManager.CreatePeakValueEvaluationSettingBuilder()

New in version NX5.0.0.

Properties

Property	Description
CombinationOptions	Returns the setting of combination evaluation.
CoordinateSystem	Returns or sets the coordinate system.
ObservationNode	Returns or sets the relative node.
Relative	Returns or sets the option of using the observation node in evaluation
ResultType	Returns or sets the result type
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDataComponents	Returns the direction data components.
GetDescriptionString	Returns the description.
GetObject	Returns the object currently being edited by this builder.
GetOutputElements	Returns the destination elements.
GetOutputNodes	Returns the destination nodes.
SetDataComponents	Sets the direction data components.
SetDescriptionString	Sets the description
SetOutputElements	Sets the destination elements
SetOutputNodes	Sets the destination nodes
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

CombinationOptions

PeakValueEvaluationSettingBuilder.CombinationOptions

Returns the setting of combination evaluation.

Only available when event type is NXOpen.CAE.ResponseSimulation.RSEventType.Random or NXOpen.CAE.ResponseSimulation.RSEventType.ResponseSpectrum

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

Getter Method

Signature CombinationOptions

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Method Detail

Validate

PeakValueEvaluationSettingBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.