NXOpen.CAE.CorrelModePairingBuilder Class Reference

This builder is used to control the mode pairing behavior of a NXOpen.CAE.CorrelSolution More...

Inheritance diagram for NXOpen.CAE.CorrelModePairingBuilder:

Public Types
enum	Auto {   None, Sequential, Frequency, Mac,   FreqMac }
	The automatic pairing rule type More...
enum	Frequency { Delta, Pct }
	The frequency mode type More...

Public Member Functions
unsafe void	AddManualPair (int refModeId, int workModeId)
	Add a manually paired mode pair More...
unsafe void	ClearAllManualPairs ()
	Clear all manually paired mode pairs More...
unsafe void	RemoveManualPair (int refModeId, int workModeId)
	Remove a manually paired mode pair More...

Properties
unsafe NXOpen.CAE.CorrelModePairingBuilder.Auto	AutomaticRule [get, set]
	Returns or sets the automatic pairing rule More...
unsafe bool	DefineModeClusters [get, set]
	Returns or sets the Define Mode Clusters flag More...
unsafe NXOpen.CAE.CorrelModePairingBuilder.Frequency	FrequencyMode [get, set]
	Returns or sets the frequency mode More...
unsafe double	FrequencyTolerance [get, set]
	Returns or sets the frequency-pairing tolerance More...
unsafe double	FrequencyTolerancePct [get, set]
	Returns or sets the frequency tolerance percentage More...
unsafe double	MacLowerBound [get, set]
	Returns or sets the minimum MAC allowable for pairing by MAC More...
unsafe bool	ModePairsOnly [get, set]
	Returns or sets the mode pairs only More...
unsafe bool	TrackingMaster [get, set]
	Returns or sets the tracking master More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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
None	not automatic
Sequential	by mode numbers
Frequency	by frequency
Mac	by mac metric
FreqMac	by frequency AND mac

enum NXOpen.CAE.CorrelModePairingBuilder.Frequency

The frequency mode type

Enumerator
Delta	by delta
Pct	by percentage

Member Function Documentation

unsafe void NXOpen.CAE.CorrelModePairingBuilder.AddManualPair ( int  refModeId, int  workModeId  )

inline

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

unsafe void NXOpen.CAE.CorrelModePairingBuilder.ClearAllManualPairs ( )

inline

Clear all manually paired mode pairs

Created in NX7.5.1

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelModePairingBuilder.RemoveManualPair ( int  refModeId, int  workModeId  )

inline

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

Property Documentation

unsafe NXOpen.CAE.CorrelModePairingBuilder.Auto NXOpen.CAE.CorrelModePairingBuilder.AutomaticRule

getset

Returns or sets the automatic pairing rule

Created in NX6.0.1

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe bool NXOpen.CAE.CorrelModePairingBuilder.DefineModeClusters

getset

Returns or sets the Define Mode Clusters flag

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe NXOpen.CAE.CorrelModePairingBuilder.Frequency NXOpen.CAE.CorrelModePairingBuilder.FrequencyMode

getset

Returns or sets the frequency mode

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe double NXOpen.CAE.CorrelModePairingBuilder.FrequencyTolerance

getset

Returns or sets the frequency-pairing tolerance

Created in NX6.0.1

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe double NXOpen.CAE.CorrelModePairingBuilder.FrequencyTolerancePct

getset

Returns or sets the frequency tolerance percentage

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe double NXOpen.CAE.CorrelModePairingBuilder.MacLowerBound

getset

Returns or sets the minimum MAC allowable for pairing by MAC

Created in NX6.0.1

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe bool NXOpen.CAE.CorrelModePairingBuilder.ModePairsOnly

getset

Returns or sets the mode pairs only

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

unsafe bool NXOpen.CAE.CorrelModePairingBuilder.TrackingMaster

getset

Returns or sets the tracking master

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_correl_base ("FE Correlation")

---

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

• CAE_CorrelModePairingBuilder.cs