PreTestExciterConfigBuilder Class

class NXOpen.CAE.PreTestExciterConfigBuilder

Bases: NXOpen.Builder

Represents a NXOpen.CAE.PreTestExciterConfig builder

To create a new instance of this class, use NXOpen.CAE.PreTestSolutionCollection.CreateExciterConfigBuilder()

Default values.

Property Value
DampingRatio 1.0
MethodChoice AutomaticNmif
NmifThreshold 0.3
OffAxisAngleChoice None

New in version NX8.0.0.

Properties

Property Description
DampingRatio Returns or sets the damping ratio
MethodChoice Returns or sets the exciter selection method
Name Returns or sets the name
NmifThreshold Returns or sets the damping ratio
OffAxisAngleChoice Returns or sets the off axis angle choice
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.
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

PreTestExciterConfigBuilderMethodChoiceType Enumeration Selected method for the exciter selection
PreTestExciterConfigBuilderOffAxisAngleChoiceType Enumeration Selected off axis angle for the exciter selection

Property Detail

DampingRatio

PreTestExciterConfigBuilder.DampingRatio

Returns or sets the damping ratio

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

Getter Method

Signature DampingRatio

Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DampingRatio

Parameters:dampingRatio (float) –

New in version NX8.0.0.

License requirements: nx_correl_base (“FE Correlation”)

MethodChoice

PreTestExciterConfigBuilder.MethodChoice

Returns or sets the exciter selection method

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

Getter Method

Signature MethodChoice

Returns:
Return type:NXOpen.CAE.PreTestExciterConfigBuilderMethodChoiceType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature MethodChoice

Parameters:algorithmChoice (NXOpen.CAE.PreTestExciterConfigBuilderMethodChoiceType) –

New in version NX8.0.0.

License requirements: nx_correl_base (“FE Correlation”)

Name

PreTestExciterConfigBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:title (str) –

New in version NX8.0.0.

License requirements: nx_correl_base (“FE Correlation”)

NmifThreshold

PreTestExciterConfigBuilder.NmifThreshold

Returns or sets the damping ratio

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

Getter Method

Signature NmifThreshold

Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature NmifThreshold

Parameters:nmifThreshold (float) –

New in version NX8.0.0.

License requirements: nx_correl_base (“FE Correlation”)

OffAxisAngleChoice

PreTestExciterConfigBuilder.OffAxisAngleChoice

Returns or sets the off axis angle choice

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

Getter Method

Signature OffAxisAngleChoice

Returns:
Return type:NXOpen.CAE.PreTestExciterConfigBuilderOffAxisAngleChoiceType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature OffAxisAngleChoice

Parameters:offAxisAngleChoice (NXOpen.CAE.PreTestExciterConfigBuilderOffAxisAngleChoiceType) –

New in version NX8.0.0.

License requirements: nx_correl_base (“FE Correlation”)

Method Detail

Validate

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