NXOpen::CAE::CorrelAlignmentBuilder Class Reference

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

Created in NX6.0.1. More...

Inheritance diagram for NXOpen::CAE::CorrelAlignmentBuilder:

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. More...
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt	GetReferencePt2 ()
	Gets the reference first axis origin point. More...
NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt	GetReferencePt3 ()
	Gets the reference second axis point. More...
bool	SaveXmlTransform ()
	Returns the save xml transform Created in NX9.0.0. More...
NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice	ScalingType ()
	Returns the scaling type Created in NX6.0.1. More...
double	ScalingValue ()
	Returns the scaling value Created in NX6.0.1. More...
void	SetReferencePt1 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt1)
	Sets the reference common origin point Created in NX6.0.2. More...
void	SetReferencePt2 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt2)
	Sets the reference first axis origin point Created in NX6.0.2. More...
void	SetReferencePt3 (const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &referencePt3)
	Sets the reference second axis point Created in NX6.0.2. More...
void	SetSaveXmlTransform (bool saveXmlTransform)
	Sets the save xml transform Created in NX9.0.0. More...
void	SetScalingType (NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice scalingType)
	Sets the scaling type Created in NX6.0.1. More...
void	SetScalingValue (double scalingValue)
	Sets the scaling value Created in NX6.0.1. More...
void	SetWrkPt1 (NXOpen::Point *wrkPt1)
	Sets the working common origin point Created in NX6.0.1. More...
void	SetWrkPt2 (NXOpen::Point *wrkPt2)
	Sets the working first axis origin point Created in NX6.0.1. More...
void	SetWrkPt3 (NXOpen::Point *wrkPt3)
	Sets the working second axis point Created in NX6.0.1. More...
NXOpen::Point *	WrkPt1 ()
	Returns the working common origin point Created in NX6.0.1. More...
NXOpen::Point *	WrkPt2 ()
	Returns the working first axis origin point Created in NX6.0.1. More...
NXOpen::Point *	WrkPt3 ()
	Returns the working second axis point Created in NX6.0.1. More...

Detailed Description

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

Created in NX6.0.1.

Member Enumeration Documentation

enum NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice

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

NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt NXOpen::CAE::CorrelAlignmentBuilder::GetReferencePt1

(

)

Gets the reference common origin point.

Returns

Created in NX6.0.2.

License requirements : None

NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt NXOpen::CAE::CorrelAlignmentBuilder::GetReferencePt2

(

)

Gets the reference first axis origin point.

Returns

Created in NX6.0.2.

License requirements : None

NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt NXOpen::CAE::CorrelAlignmentBuilder::GetReferencePt3

(

)

Gets the reference second axis point.

Returns

Created in NX6.0.2.

License requirements : None

bool NXOpen::CAE::CorrelAlignmentBuilder::SaveXmlTransform

(

)

Returns the save xml transform
Created in NX9.0.0.

License requirements : None

NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice NXOpen::CAE::CorrelAlignmentBuilder::ScalingType

(

)

Returns the scaling type
Created in NX6.0.1.

License requirements : None

double NXOpen::CAE::CorrelAlignmentBuilder::ScalingValue

(

)

Returns the scaling value
Created in NX6.0.1.

License requirements : None

void NXOpen::CAE::CorrelAlignmentBuilder::SetReferencePt1

(

const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &

referencePt1

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

referencePt1

Reference Point 1

void NXOpen::CAE::CorrelAlignmentBuilder::SetReferencePt2

(

const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &

referencePt2

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

referencePt2

Reference Point 2

void NXOpen::CAE::CorrelAlignmentBuilder::SetReferencePt3

(

const NXOpen::CAE::CorrelAlignmentBuilder::ReferencePt &

referencePt3

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

referencePt3

Reference Point 3

void NXOpen::CAE::CorrelAlignmentBuilder::SetSaveXmlTransform

(

bool

saveXmlTransform

)

Sets the save xml transform
Created in NX9.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters

saveXmlTransform

savexmltransform

void NXOpen::CAE::CorrelAlignmentBuilder::SetScalingType

(

NXOpen::CAE::CorrelAlignmentBuilder::ScalingChoice

scalingType

)

Sets the scaling type
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

scalingType

scalingtype

void NXOpen::CAE::CorrelAlignmentBuilder::SetScalingValue

(

double

scalingValue

)

Sets the scaling value
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

scalingValue

scalingvalue

void NXOpen::CAE::CorrelAlignmentBuilder::SetWrkPt1

(

NXOpen::Point *

wrkPt1

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

wrkPt1

wrkpt1

void NXOpen::CAE::CorrelAlignmentBuilder::SetWrkPt2

(

NXOpen::Point *

wrkPt2

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

wrkPt2

wrkpt2

void NXOpen::CAE::CorrelAlignmentBuilder::SetWrkPt3

(

NXOpen::Point *

wrkPt3

)

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

License requirements : nx_correl_base ("FE Correlation")

Parameters

wrkPt3

wrkpt3

NXOpen::Point* NXOpen::CAE::CorrelAlignmentBuilder::WrkPt1

(

)

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

License requirements : None

NXOpen::Point* NXOpen::CAE::CorrelAlignmentBuilder::WrkPt2

(

)

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

License requirements : None

NXOpen::Point* NXOpen::CAE::CorrelAlignmentBuilder::WrkPt3

(

)

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:

• CAE_CorrelAlignmentBuilder.hxx