CorrelModePairingBuilder Class¶
-
class
NXOpen.CAE.CorrelModePairingBuilder¶ Bases:
NXOpen.CAE.CorrelBaseBuilderThis builder is used to control the mode pairing behavior of a
NXOpen.CAE.CorrelSolutionTo create a new instance of this class, use
NXOpen.CAE.CorrelSolution.CreateModePairingBuilder()New in version NX6.0.1.
Properties¶
| Property | Description |
|---|---|
| AutomaticRule | Returns or sets the automatic pairing rule |
| FrequencyTolerance | Returns or sets the frequency-pairing tolerance |
| MacLowerBound | Returns or sets the minimum MAC allowable for pairing by MAC |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddManualPair | Add a manually paired mode pair |
| ClearAllManualPairs | Clear all manually paired mode pairs |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| RemoveManualPair | Remove a manually paired mode pair |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| CorrelModePairingBuilderAuto Enumeration | The automatic pairing rule type |
Property Detail¶
AutomaticRule¶
-
CorrelModePairingBuilder.AutomaticRule¶ Returns or sets the automatic pairing rule
-------------------------------------Getter Method
Signature
AutomaticRuleReturns: returns the automatic rule. Return type: NXOpen.CAE.CorrelModePairingBuilderAutoNew in version NX6.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
AutomaticRuleParameters: rule ( NXOpen.CAE.CorrelModePairingBuilderAuto) –New in version NX6.0.1.
License requirements: nx_correl_base (“FE Correlation”)
FrequencyTolerance¶
-
CorrelModePairingBuilder.FrequencyTolerance¶ Returns or sets the frequency-pairing tolerance
-------------------------------------Getter Method
Signature
FrequencyToleranceReturns: returns the frequency tolerance. Return type: float New in version NX6.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
FrequencyToleranceParameters: frequencyTol (float) – New in version NX6.0.1.
License requirements: nx_correl_base (“FE Correlation”)
MacLowerBound¶
-
CorrelModePairingBuilder.MacLowerBound¶ Returns or sets the minimum MAC allowable for pairing by MAC
-------------------------------------Getter Method
Signature
MacLowerBoundReturns: returns the MAC limit. Return type: float New in version NX6.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
MacLowerBoundParameters: macLowerBound (float) – New in version NX6.0.1.
License requirements: nx_correl_base (“FE Correlation”)
Method Detail¶
AddManualPair¶
-
CorrelModePairingBuilder.AddManualPair¶ Add a manually paired mode pair
Signature
AddManualPair(refModeId, workModeId)Parameters: - refModeId (int) – Reference mode ID
- workModeId (int) – Work mode ID
New in version NX7.5.1.
License requirements: nx_correl_base (“FE Correlation”)
ClearAllManualPairs¶
-
CorrelModePairingBuilder.ClearAllManualPairs¶ Clear all manually paired mode pairs
Signature
ClearAllManualPairs()New in version NX7.5.1.
License requirements: nx_correl_base (“FE Correlation”)
RemoveManualPair¶
-
CorrelModePairingBuilder.RemoveManualPair¶ Remove a manually paired mode pair
Signature
RemoveManualPair(refModeId, workModeId)Parameters: - refModeId (int) – Reference mode ID
- workModeId (int) – Work mode ID
New in version NX7.5.1.
License requirements: nx_correl_base (“FE Correlation”)
Validate¶
-
CorrelModePairingBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.