NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::CAE::CorrelAlignmentBuilder Class Reference

This builder is used to control the alignment parameters of a CAE::CorrelSolution
To create a new instance of this class, use CAE::SimSolution::CreateAlignmentBuilder

Created in NX6.0.1. More...

Inheritance diagram for NXOpen::CAE::CorrelAlignmentBuilder:
NXOpen::CAE::CorrelBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Classes

struct  ReferencePt
 Specifies the data for the selected reference points. More...

Public Types

enum  ScalingChoice { ScalingChoiceFromSecondAxis, ScalingChoiceSpecify }
 the way the scaling factor is computed More...

Public Member Functions

NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetReferencePt1 ()
 Gets the reference common origin point.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetReferencePt2 ()
 Gets the reference first axis origin point.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetReferencePt3 ()
 Gets the reference second axis point.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetWrkNode1 ()
 Gets the working common origin point position - obselete version.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetWrkNode2 ()
 Gets the working first axis point position - obselete version.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt GetWrkNode3 ()
 Gets the working second axis point position - obselete version.
NXOpen::CAE::SelectFENodeRefPt1 ()
 Returns the reference common origin node -- obsolete version

NXOpen::CAE::SelectFENodeRefPt2 ()
 Returns the reference first axis node -- obsolete version

NXOpen::CAE::SelectFENodeRefPt3 ()
 Returns the reference second axis node -- obsolete version

NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice ScalingType ()
 Returns the scaling type
Created in NX6.0.1.
double ScalingValue ()
 Returns the scaling value
Created in NX6.0.1.
void SetReferencePt1 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt1)
 Sets the reference common origin point
Created in NX6.0.2.
void SetReferencePt2 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt2)
 Sets the reference first axis origin point
Created in NX6.0.2.
void SetReferencePt3 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt3)
 Sets the reference second axis point
Created in NX6.0.2.
void SetScalingType (NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice scalingType)
 Sets the scaling type
Created in NX6.0.1.
void SetScalingValue (double scalingValue)
 Sets the scaling value
Created in NX6.0.1.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt SetWrkNode1 ()
 Sets the working common origin point position - obselete version.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt SetWrkNode2 ()
 Sets the working first axis point position - obselete version.
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt SetWrkNode3 ()
 Sets the working second axis point position - obselete version.
void SetWrkPt1 (NXOpen::Point *wrkPt1)
 Sets the working common origin point
Created in NX6.0.1.
void SetWrkPt2 (NXOpen::Point *wrkPt2)
 Sets the working first axis origin point
Created in NX6.0.1.
void SetWrkPt3 (NXOpen::Point *wrkPt3)
 Sets the working second axis point
Created in NX6.0.1.
NXOpen::PointWrkPt1 ()
 Returns the working common origin point
Created in NX6.0.1.
NXOpen::PointWrkPt2 ()
 Returns the working first axis origin point
Created in NX6.0.1.
NXOpen::PointWrkPt3 ()
 Returns the working second axis point
Created in NX6.0.1.

Detailed Description

This builder is used to control the alignment parameters of a CAE::CorrelSolution
To create a new instance of this class, use CAE::SimSolution::CreateAlignmentBuilder

Created in NX6.0.1.



Member Enumeration Documentation

the way the scaling factor is computed

Enumerator:
ScalingChoiceFromSecondAxis 

Computed from the lenght of the second axis.

ScalingChoiceSpecify 

User specified scaling factor.


Member Function Documentation

Gets the reference common origin point.

Returns:

Created in NX6.0.2.

License requirements : None

Gets the reference first axis origin point.

Returns:

Created in NX6.0.2.

License requirements : None

Gets the reference second axis point.

Returns:

Created in NX6.0.2.

License requirements : None

Gets the working common origin point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : None

Gets the working first axis point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : None

Gets the working second axis point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : None

Returns the reference common origin node -- obsolete version

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : None

Returns the reference first axis node -- obsolete version

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : None

Returns the reference second axis node -- obsolete version

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : None

Returns the scaling type
Created in NX6.0.1.



License requirements : None

Returns the scaling value
Created in NX6.0.1.



License requirements : None

Sets the reference common origin point
Created in NX6.0.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
referencePt1Reference Point 1

Sets the reference first axis origin point
Created in NX6.0.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
referencePt2Reference Point 2

Sets the reference second axis point
Created in NX6.0.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
referencePt3Reference Point 3

Sets the scaling type
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
scalingTypescalingtype

Sets the scaling value
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
scalingValuescalingvalue

Sets the working common origin point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : nx_correl_base ("FE Correlation")

Sets the working first axis point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : nx_correl_base ("FE Correlation")

Sets the working second axis point position - obselete version.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.2.

License requirements : nx_correl_base ("FE Correlation")

Sets the working common origin point
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
wrkPt1wrkpt1

Sets the working first axis origin point
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
wrkPt2wrkpt2

Sets the working second axis point
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
wrkPt3wrkpt3

Returns the working common origin point
Created in NX6.0.1.



License requirements : None

Returns the working first axis origin point
Created in NX6.0.1.



License requirements : None

Returns the working second axis point
Created in NX6.0.1.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.