EffectivityConditionBuilder Class¶
-
class
NXOpen.
EffectivityConditionBuilder
¶ Bases:
NXOpen.Builder
Represent a utility class to assign or edit discrete and range effectivity unit values in the context of a
NXOpen.CollaborativeDesign
.Also provides method to apply all units or no units effectivity.
To create a new instance of this class, use
NXOpen.BasePart.CreateEffectivityConditionBuilder()
Default values.
Property Value EffectivityType Unit New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
EffectivityFormula | Returns the string representation of effectivity |
EffectivityType | Returns or sets the effectivity type |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddUnitEffectivity | Adds specified discrete or range effectivity values to the builder. |
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. |
RegisterBasicEffectivityBuilder | Registers the NXOpen.BasicEffectivityBuilder to make sure its effectivity formula string is always updated and in sync with the effectivity formula string of this class. |
RemoveUnitEffectivity | Removes specified existing range effectivity values from the builder. |
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¶
EffectivityConditionBuilderEffectivityConditionType Enumeration | Specifies the effectivity type option |
EffectivityConditionBuilderToUnitType Enumeration | Specifies option for range effectivity value’s toUnit. |
Property Detail¶
EffectivityFormula¶
-
EffectivityConditionBuilder.
EffectivityFormula
¶ Returns the string representation of effectivity
-------------------------------------
Getter Method
Signature
EffectivityFormula
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
EffectivityType¶
-
EffectivityConditionBuilder.
EffectivityType
¶ Returns or sets the effectivity type
-------------------------------------
Getter Method
Signature
EffectivityType
Returns: Return type: NXOpen.EffectivityConditionBuilderEffectivityConditionType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EffectivityType
Parameters: selectTypeEffectivity ( NXOpen.EffectivityConditionBuilderEffectivityConditionType
) –New in version NX8.5.0.
License requirements: None.
Method Detail¶
AddUnitEffectivity¶
-
EffectivityConditionBuilder.
AddUnitEffectivity
¶ Overloaded method AddUnitEffectivity
AddUnitEffectivity(fromUnit, toUnit)
AddUnitEffectivity(fromUnit, toUnitType)
-------------------------------------
Adds specified discrete or range effectivity values to the builder. If the input is a single discrete unit value then pass fromUnit and toUnit as same.
Signature
AddUnitEffectivity(fromUnit, toUnit)
Parameters: - fromUnit (int) –
- toUnit (int) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Adds specified range effectivity value to the builder. This method can be used to set Stock out or Open End as effectivity range’s to unit by passing
NXOpen.EffectivityConditionBuilderToUnitType.StockOut
orNXOpen.EffectivityConditionBuilderToUnitType.OpenEnd
respectively. This method is valid only for effectivity typeNXOpen.EffectivityConditionBuilderEffectivityConditionType.UnitRange
.Signature
AddUnitEffectivity(fromUnit, toUnitType)
Parameters: - fromUnit (int) –
- toUnitType (
NXOpen.EffectivityConditionBuilderToUnitType
) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
RegisterBasicEffectivityBuilder¶
-
EffectivityConditionBuilder.
RegisterBasicEffectivityBuilder
¶ Registers the
NXOpen.BasicEffectivityBuilder
to make sure its effectivity formula string is always updated and in sync with the effectivity formula string of this class.This method should be called before the commit method is invoked.
Signature
RegisterBasicEffectivityBuilder(beBuilder)
Parameters: beBuilder ( NXOpen.BasicEffectivityBuilder
) –New in version NX8.5.0.
License requirements: None.
RemoveUnitEffectivity¶
-
EffectivityConditionBuilder.
RemoveUnitEffectivity
¶ Overloaded method RemoveUnitEffectivity
RemoveUnitEffectivity(fromUnit, toUnit)
RemoveUnitEffectivity(fromUnit, toUnitType)
-------------------------------------
Removes specified existing range effectivity values from the builder. To remove single discrete unit value, pass fromUnit and toUnit as same.
Signature
RemoveUnitEffectivity(fromUnit, toUnit)
Parameters: - fromUnit (int) –
- toUnit (int) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Removes specified existing range unit effectivity which has toUnit value either
NXOpen.EffectivityConditionBuilderToUnitType.StockOut
orNXOpen.EffectivityConditionBuilderToUnitType.OpenEnd
repectively.Signature
RemoveUnitEffectivity(fromUnit, toUnitType)
Parameters: - fromUnit (int) –
- toUnitType (
NXOpen.EffectivityConditionBuilderToUnitType
) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Validate¶
-
EffectivityConditionBuilder.
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.