CSDExcitationBuilder Class

class NXOpen.CAE.ResponseSimulation.CSDExcitationBuilder

Bases: NXOpen.CAE.ResponseSimulation.ExcitationBuilder

Represents the manager to NXOpen.CAE.ResponseSimulation.CSDExcitation.

The object of type NXOpen.CAE.ResponseSimulation.CSDExcitation can only be created or edited through this class.

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

New in version NX5.0.0.

Properties

Property Description
CorrelationType Returns or sets the correlation type
CorrelationValue Returns or sets the correlation type
DynamicEvent Returns the parent dynamic event object
ExcitationLocationDefinition Returns the excitation location definition
ObjectLabel Returns the object label
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.
GetFromFunction Returns the from function
GetObject Returns the object currently being edited by this builder.
GetToFunction Returns the to function
SetFromFunction Sets the from function
SetToFunction Sets the to function
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

CorrelationType

CSDExcitationBuilder.CorrelationType

Returns or sets the correlation type

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

Getter Method

Signature CorrelationType

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature CorrelationType

Parameters:type (NXOpen.CAE.ResponseSimulation.CSDExcitationCorrelationType) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

CorrelationValue

CSDExcitationBuilder.CorrelationValue

Returns or sets the correlation type

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

Getter Method

Signature CorrelationValue

Returns:
Return type:float

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature CorrelationValue

Parameters:correlationValue (float) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Method Detail

GetFromFunction

CSDExcitationBuilder.GetFromFunction

Returns the from function

Signature GetFromFunction()

Returns:a tuple
Return type:A tuple consisting of (fromExcitation, componentType). fromExcitation is a NXOpen.CAE.ResponseSimulation.Excitation. componentType is a NXOpen.CAE.ResponseSimulation.ExcitationComponent.

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

GetToFunction

CSDExcitationBuilder.GetToFunction

Returns the to function

Signature GetToFunction()

Returns:a tuple
Return type:A tuple consisting of (toExcitation, componentType). toExcitation is a NXOpen.CAE.ResponseSimulation.Excitation. componentType is a NXOpen.CAE.ResponseSimulation.ExcitationComponent.

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SetFromFunction

CSDExcitationBuilder.SetFromFunction

Sets the from function

Signature SetFromFunction(fromExcitation, componentType)

Parameters:

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SetToFunction

CSDExcitationBuilder.SetToFunction

Sets the to function

Signature SetToFunction(toExcitation, componentType)

Parameters:

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Validate

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