NX Open C++ Reference Guide
Public Types | Public Member Functions
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:
NXOpen::CAE::CorrelBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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

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:
refModeIdReference mode ID
workModeIdWork mode ID

Returns the automatic pairing rule
Created in NX6.0.1.



License requirements : None

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



License requirements : nx_correl_base ("FE Correlation")

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



License requirements : None

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:
refModeIdReference mode ID
workModeIdWork mode ID

Sets the automatic pairing rule
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
rulerule

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



License requirements : nx_correl_base ("FE Correlation")

Parameters:
frequencyTolfrequency tol

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



License requirements : nx_correl_base ("FE Correlation")

Parameters:
macLowerBoundmac lower bound

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