This builder is used to control the mode pairing behavior of a NXOpen::CAE::CorrelSolution
To create a new instance of this class, use NXOpen::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...

enum	Frequency { FrequencyDelta, FrequencyPct }
	The frequency mode type. More...

Public Member Functions
void	AddManualPair (int refModeId, int workModeId)
	Add a manually paired mode pair Created in NX7.5.1. More...

NXOpen::CAE::CorrelModePairingBuilder::Auto	AutomaticRule ()
	Returns the automatic pairing rule Created in NX6.0.1. More...

void	ClearAllManualPairs ()
	Clear all manually paired mode pairs Created in NX7.5.1. More...

NXOpen::CAE::CorrelModePairingBuilder::Frequency	FrequencyMode ()
	Returns the frequency mode Created in NX1847.0.0. More...

double	FrequencyTolerance ()
	Returns the frequency-pairing tolerance Created in NX6.0.1. More...

double	FrequencyTolerancePct ()
	Returns the frequency tolerance percentage Created in NX1847.0.0. More...

double	MacLowerBound ()
	Returns the minimum MAC allowable for pairing by MAC Created in NX6.0.1. More...

bool	ModePairsOnly ()
	Returns the mode pairs only Created in NX1847.0.0. More...

void	RemoveManualPair (int refModeId, int workModeId)
	Remove a manually paired mode pair Created in NX7.5.1. More...

void	SetAutomaticRule (NXOpen::CAE::CorrelModePairingBuilder::Auto rule)
	Sets the automatic pairing rule Created in NX6.0.1. More...

void	SetFrequencyMode (NXOpen::CAE::CorrelModePairingBuilder::Frequency frequencyMode)
	Sets the frequency mode Created in NX1847.0.0. More...

void	SetFrequencyTolerance (double frequencyTol)
	Sets the frequency-pairing tolerance Created in NX6.0.1. More...

void	SetFrequencyTolerancePct (double frequencyTolerancePct)
	Sets the frequency tolerance percentage Created in NX1847.0.0. More...

void	SetMacLowerBound (double macLowerBound)
	Sets the minimum MAC allowable for pairing by MAC Created in NX6.0.1. More...

void	SetModePairsOnly (bool modePairsOnly)
	Sets the mode pairs only Created in NX1847.0.0. More...

void	SetTrackingMaster (bool isTrackingMasterRef)
	Sets the tracking master Created in NX1847.0.0. More...

bool	TrackingMaster ()
	Returns the tracking master Created in NX1847.0.0. More...

Detailed Description

This builder is used to control the mode pairing behavior of a NXOpen::CAE::CorrelSolution
To create a new instance of this class, use NXOpen::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

enum NXOpen::CAE::CorrelModePairingBuilder::Frequency

The frequency mode type.

Enumerator
FrequencyDelta	by delta
FrequencyPct	by percentage

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")

NXOpen::CAE::CorrelModePairingBuilder::Frequency NXOpen::CAE::CorrelModePairingBuilder::FrequencyMode ( )

Returns the frequency mode
Created in NX1847.0.0.

License requirements : None

double NXOpen::CAE::CorrelModePairingBuilder::FrequencyTolerance ( )

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

License requirements : None

double NXOpen::CAE::CorrelModePairingBuilder::FrequencyTolerancePct ( )

Returns the frequency tolerance percentage
Created in NX1847.0.0.

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

bool NXOpen::CAE::CorrelModePairingBuilder::ModePairsOnly ( )

Returns the mode pairs only
Created in NX1847.0.0.

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::SetFrequencyMode ( NXOpen::CAE::CorrelModePairingBuilder::Frequency frequencyMode )

Sets the frequency mode
Created in NX1847.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters

frequencyMode frequency mode

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::SetFrequencyTolerancePct ( double frequencyTolerancePct )

Sets the frequency tolerance percentage
Created in NX1847.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters

frequencyTolerancePct frequency tolerance pct

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

void NXOpen::CAE::CorrelModePairingBuilder::SetModePairsOnly ( bool modePairsOnly )

Sets the mode pairs only
Created in NX1847.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters

modePairsOnly mode pairs only

void NXOpen::CAE::CorrelModePairingBuilder::SetTrackingMaster ( bool isTrackingMasterRef )

Sets the tracking master
Created in NX1847.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters

isTrackingMasterRef is tracking master ref

bool NXOpen::CAE::CorrelModePairingBuilder::TrackingMaster ( )

Returns the tracking master
Created in NX1847.0.0.

License requirements : None

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

CAE_CorrelModePairingBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation