TranslationalNodalFunctionExcitationBuilder Class

class NXOpen.CAE.ResponseSimulation.TranslationalNodalFunctionExcitationBuilder

Bases: NXOpen.CAE.ResponseSimulation.NodalFunctionExcitationBuilder

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

The objects of NXOpen.CAE.ResponseSimulation.TranslationalNodalFunctionExcitation can be created or edited on through this class To create a new instance of this class, use NXOpen.CAE.ResponseSimulation.ExcitationCollection.CreateTranslationalNodalFunctionExcitationBuilder()

New in version NX5.0.0.

Properties

Property	Description
DynamicEvent	Returns the parent dynamic event object
EnableUserDefinedDirection	Returns or sets the excitation function definition method
EnableUserDefinedRotation	Returns or sets the excitation function definition method
ExcitationLocationDefinition	Returns the excitation location definition
FunctionComponentX	Returns the function component of X direction
FunctionComponentY	Returns the function component of Y direction
FunctionComponentZ	Returns the function component of Z direction
ObjectLabel	Returns the object label
RotationAxis	Returns or sets the rotation axis
Tag	Returns the Tag for this object.
UserDefinedDirection	Returns or sets the magnitude direction
UserDefinedFunction	Returns the magnitude function

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.
GetObject	Returns the object currently being edited by this builder.
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.

Enumerations

TranslationalNodalFunctionExcitationBuilderRotationAxisType Enumeration

Represents the rotation axis type.

Property Detail

EnableUserDefinedDirection

TranslationalNodalFunctionExcitationBuilder.EnableUserDefinedDirection

Returns or sets the excitation function definition method

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

Getter Method

Signature EnableUserDefinedDirection

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature EnableUserDefinedDirection

Parameters:enableUserDefinedDirection (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

EnableUserDefinedRotation

TranslationalNodalFunctionExcitationBuilder.EnableUserDefinedRotation

Returns or sets the excitation function definition method

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

Getter Method

Signature EnableUserDefinedRotation

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature EnableUserDefinedRotation

Parameters:enableUserDefinedRotation (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

FunctionComponentX

TranslationalNodalFunctionExcitationBuilder.FunctionComponentX

Returns the function component of X direction

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

Getter Method

Signature FunctionComponentX

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

FunctionComponentY

TranslationalNodalFunctionExcitationBuilder.FunctionComponentY

Returns the function component of Y direction

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

Getter Method

Signature FunctionComponentY

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

FunctionComponentZ

TranslationalNodalFunctionExcitationBuilder.FunctionComponentZ

Returns the function component of Z direction

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

Getter Method

Signature FunctionComponentZ

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

RotationAxis

TranslationalNodalFunctionExcitationBuilder.RotationAxis

Returns or sets the rotation axis

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

Getter Method

Signature RotationAxis

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature RotationAxis

Parameters:rotationAxis (NXOpen.CAE.ResponseSimulation.TranslationalNodalFunctionExcitationBuilderRotationAxisType) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

UserDefinedDirection

TranslationalNodalFunctionExcitationBuilder.UserDefinedDirection

Returns or sets the magnitude direction

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

Getter Method

Signature UserDefinedDirection

Returns: Return type:NXOpen.Direction

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

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

Setter Method

Signature UserDefinedDirection

Parameters:magnitudeDirection (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

UserDefinedFunction

TranslationalNodalFunctionExcitationBuilder.UserDefinedFunction

Returns the magnitude function

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

Getter Method

Signature UserDefinedFunction

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

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Method Detail

Validate

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