CorrelFineTuneAlignmentBuilder Class

class NXOpen.CAE.CorrelFineTuneAlignmentBuilder

Bases: NXOpen.CAE.CorrelBaseBuilder

This builder is used to nudge the alignment by a fine adjustment

To create a new instance of this class, use NXOpen.CAE.CorrelManager.CreateCorrelFineTuneAlignmentBuilder()

New in version NX9.0.0.

Properties

Property	Description
AngleEnum	Returns or sets the angle vector enumeration
AngularExp	Returns the angular expression
DistanceEnum	Returns or sets the distance vector enumeration
DistanceExp	Returns the distance expression
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.
MoveButton	The move button to nudge alignment by the defined distance along the selected distance vector
RotateButton	The rotate button to nudge alignment by the defined angle via the selected angle vector
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

CorrelFineTuneAlignmentBuilderAngleVector Enumeration	the angle vector enumeration for the alignment nudge
CorrelFineTuneAlignmentBuilderDistanceVector Enumeration	the distance vector enumeration for the alignment nudge

Property Detail

AngleEnum

CorrelFineTuneAlignmentBuilder.AngleEnum

Returns or sets the angle vector enumeration

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

Getter Method

Signature AngleEnum

Returns: Return type:NXOpen.CAE.CorrelFineTuneAlignmentBuilderAngleVector

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature AngleEnum

Parameters:angleEnum (NXOpen.CAE.CorrelFineTuneAlignmentBuilderAngleVector) –

New in version NX9.0.0.

License requirements: nx_correl_base (“FE Correlation”)

AngularExp

CorrelFineTuneAlignmentBuilder.AngularExp

Returns the angular expression

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

Getter Method

Signature AngularExp

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

DistanceEnum

CorrelFineTuneAlignmentBuilder.DistanceEnum

Returns or sets the distance vector enumeration

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

Getter Method

Signature DistanceEnum

Returns: Return type:NXOpen.CAE.CorrelFineTuneAlignmentBuilderDistanceVector

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature DistanceEnum

Parameters:distanceEnum (NXOpen.CAE.CorrelFineTuneAlignmentBuilderDistanceVector) –

New in version NX9.0.0.

License requirements: nx_correl_base (“FE Correlation”)

DistanceExp

CorrelFineTuneAlignmentBuilder.DistanceExp

Returns the distance expression

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

Getter Method

Signature DistanceExp

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

Method Detail

MoveButton

CorrelFineTuneAlignmentBuilder.MoveButton

The move button to nudge alignment by the defined distance along the selected distance vector

Signature MoveButton()

New in version NX9.0.0.

License requirements: nx_correl_base (“FE Correlation”)

RotateButton

CorrelFineTuneAlignmentBuilder.RotateButton

The rotate button to nudge alignment by the defined angle via the selected angle vector

Signature RotateButton()

New in version NX9.0.0.

License requirements: nx_correl_base (“FE Correlation”)

Validate

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