CorrelAlignmentBuilder Class

class NXOpen.CAE.CorrelAlignmentBuilder

Bases: NXOpen.CAE.CorrelBaseBuilder

This builder is used to control the alignment parameters of a NXOpen.CAE.CorrelSolution

To create a new instance of this class, use NXOpen.CAE.SimSolution.CreateAlignmentBuilder()

New in version NX6.0.1.

Properties

Property Description
SaveXmlTransform Returns or sets the save xml transform
ScalingType Returns or sets the scaling type
ScalingValue Returns or sets the scaling value
Tag Returns the Tag for this object.
WrkPt1 Returns or sets the working common origin point
WrkPt2 Returns or sets the working first axis origin point
WrkPt3 Returns or sets the working second axis point

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.
GetReferencePt1 Gets the reference common origin point
GetReferencePt2 Gets the reference first axis origin point
GetReferencePt3 Gets the reference second axis point
SetReferencePt1 Sets the reference common origin point
SetReferencePt2 Sets the reference first axis origin point
SetReferencePt3 Sets the reference second axis point
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

CorrelAlignmentBuilderScalingChoice Enumeration the way the scaling factor is computed

Structs

CorrelAlignmentBuilderReferencePt_Struct Struct Specifies the data for the selected reference points

Property Detail

SaveXmlTransform

CorrelAlignmentBuilder.SaveXmlTransform

Returns or sets the save xml transform

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

Getter Method

Signature SaveXmlTransform

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SaveXmlTransform

Parameters:saveXmlTransform (bool) –

New in version NX9.0.0.

License requirements: nx_correl_base (“FE Correlation”)

ScalingType

CorrelAlignmentBuilder.ScalingType

Returns or sets the scaling type

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

Getter Method

Signature ScalingType

Returns:
Return type:NXOpen.CAE.CorrelAlignmentBuilderScalingChoice

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature ScalingType

Parameters:scalingType (NXOpen.CAE.CorrelAlignmentBuilderScalingChoice) –

New in version NX6.0.1.

License requirements: nx_correl_base (“FE Correlation”)

ScalingValue

CorrelAlignmentBuilder.ScalingValue

Returns or sets the scaling value

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

Getter Method

Signature ScalingValue

Returns:
Return type:float

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature ScalingValue

Parameters:scalingValue (float) –

New in version NX6.0.1.

License requirements: nx_correl_base (“FE Correlation”)

WrkPt1

CorrelAlignmentBuilder.WrkPt1

Returns or sets the working common origin point

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

Getter Method

Signature WrkPt1

Returns:
Return type:NXOpen.Point

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature WrkPt1

Parameters:wrkPt1 (NXOpen.Point) –

New in version NX6.0.1.

License requirements: nx_correl_base (“FE Correlation”)

WrkPt2

CorrelAlignmentBuilder.WrkPt2

Returns or sets the working first axis origin point

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

Getter Method

Signature WrkPt2

Returns:
Return type:NXOpen.Point

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature WrkPt2

Parameters:wrkPt2 (NXOpen.Point) –

New in version NX6.0.1.

License requirements: nx_correl_base (“FE Correlation”)

WrkPt3

CorrelAlignmentBuilder.WrkPt3

Returns or sets the working second axis point

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

Getter Method

Signature WrkPt3

Returns:
Return type:NXOpen.Point

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature WrkPt3

Parameters:wrkPt3 (NXOpen.Point) –

New in version NX6.0.1.

License requirements: nx_correl_base (“FE Correlation”)

Method Detail

GetReferencePt1

CorrelAlignmentBuilder.GetReferencePt1

Gets the reference common origin point

Signature GetReferencePt1()

Returns:
Return type:NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct

New in version NX6.0.2.

License requirements: None.

GetReferencePt2

CorrelAlignmentBuilder.GetReferencePt2

Gets the reference first axis origin point

Signature GetReferencePt2()

Returns:
Return type:NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct

New in version NX6.0.2.

License requirements: None.

GetReferencePt3

CorrelAlignmentBuilder.GetReferencePt3

Gets the reference second axis point

Signature GetReferencePt3()

Returns:
Return type:NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct

New in version NX6.0.2.

License requirements: None.

SetReferencePt1

CorrelAlignmentBuilder.SetReferencePt1

Sets the reference common origin point

Signature SetReferencePt1(referencePt1)

Parameters:referencePt1 (NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct) – Reference Point 1

New in version NX6.0.2.

License requirements: nx_correl_base (“FE Correlation”)

SetReferencePt2

CorrelAlignmentBuilder.SetReferencePt2

Sets the reference first axis origin point

Signature SetReferencePt2(referencePt2)

Parameters:referencePt2 (NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct) – Reference Point 2

New in version NX6.0.2.

License requirements: nx_correl_base (“FE Correlation”)

SetReferencePt3

CorrelAlignmentBuilder.SetReferencePt3

Sets the reference second axis point

Signature SetReferencePt3(referencePt3)

Parameters:referencePt3 (NXOpen.CAE.CorrelAlignmentBuilderReferencePt_Struct) – Reference Point 3

New in version NX6.0.2.

License requirements: nx_correl_base (“FE Correlation”)

Validate

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