NXOpen::CAE::CorrelModePairingBuilder Class Reference

This builder is used to control the mode pairing behavior of a CAE::CorrelSolution
To create a new instance of this class, use CAE::CorrelSolution::CreateModePairingBuilder

Created in NX6.0.1. More...

Inheritance diagram for NXOpen::CAE::CorrelModePairingBuilder:

Public Types
enum	Auto {   AutoNone, AutoSequential, AutoFrequency, AutoMac,   AutoFreqMac }
	The automatic pairing rule type. More...

Public Member Functions
void	AddManualPair (int refModeId, int workModeId)
	Add a manually paired mode pair Created in NX7.5.1.
NXOpen::CAE::CorrelModePairingBuilder::Auto	AutomaticRule ()
	Returns the automatic pairing rule Created in NX6.0.1.
void	ClearAllManualPairs ()
	Clear all manually paired mode pairs Created in NX7.5.1.
double	FrequencyTolerance ()
	Returns the frequency-pairing tolerance Created in NX6.0.1.
double	MacLowerBound ()
	Returns the minimum MAC allowable for pairing by MAC Created in NX6.0.1.
void	RemoveManualPair (int refModeId, int workModeId)
	Remove a manually paired mode pair Created in NX7.5.1.
void	SetAutomaticRule (NXOpen::CAE::CorrelModePairingBuilder::Auto rule)
	Sets the automatic pairing rule Created in NX6.0.1.
void	SetFrequencyTolerance (double frequencyTol)
	Sets the frequency-pairing tolerance Created in NX6.0.1.
void	SetMacLowerBound (double macLowerBound)
	Sets the minimum MAC allowable for pairing by MAC Created in NX6.0.1.

Detailed Description

This builder is used to control the mode pairing behavior of a CAE::CorrelSolution
To create a new instance of this class, use CAE::CorrelSolution::CreateModePairingBuilder

Created in NX6.0.1.

Member Enumeration Documentation

enum NXOpen::CAE::CorrelModePairingBuilder::Auto

The automatic pairing rule type.

Enumerator:

AutoNone	not automatic
AutoSequential	by mode numbers
AutoFrequency	by frequency
AutoMac	by mac metric
AutoFreqMac	by frequency AND mac

Member Function Documentation

void NXOpen::CAE::CorrelModePairingBuilder::AddManualPair	(	int	refModeId,
		int	workModeId
	)

Add a manually paired mode pair
Created in NX7.5.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

refModeId	Reference mode ID
workModeId	Work mode ID

NXOpen::CAE::CorrelModePairingBuilder::Auto NXOpen::CAE::CorrelModePairingBuilder::AutomaticRule

(

)

Returns the automatic pairing rule
Created in NX6.0.1.

License requirements : None

void NXOpen::CAE::CorrelModePairingBuilder::ClearAllManualPairs

(

)

Clear all manually paired mode pairs
Created in NX7.5.1.

License requirements : nx_correl_base ("FE Correlation")

double NXOpen::CAE::CorrelModePairingBuilder::FrequencyTolerance

(

)

Returns the frequency-pairing tolerance
Created in NX6.0.1.

License requirements : None

double NXOpen::CAE::CorrelModePairingBuilder::MacLowerBound

(

)

Returns the minimum MAC allowable for pairing by MAC
Created in NX6.0.1.

License requirements : None

void NXOpen::CAE::CorrelModePairingBuilder::RemoveManualPair	(	int	refModeId,
		int	workModeId
	)

Remove a manually paired mode pair
Created in NX7.5.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

refModeId	Reference mode ID
workModeId	Work mode ID

void NXOpen::CAE::CorrelModePairingBuilder::SetAutomaticRule

(

NXOpen::CAE::CorrelModePairingBuilder::Auto

rule

)

Sets the automatic pairing rule
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

rule

rule

void NXOpen::CAE::CorrelModePairingBuilder::SetFrequencyTolerance

(

double

frequencyTol

)

Sets the frequency-pairing tolerance
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

frequencyTol

frequency tol

void NXOpen::CAE::CorrelModePairingBuilder::SetMacLowerBound

(

double

macLowerBound

)

Sets the minimum MAC allowable for pairing by MAC
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters

macLowerBound

mac lower bound

---

The documentation for this class was generated from the following file:

• CAE_CorrelModePairingBuilder.hxx