Represent a utility class to assign or edit discrete and range effectivity unit values in the context of a NXOpen.CollaborativeDesign . More...
Public Types | |
| enum | EffectivityConditionType { Unit, UnitRange } |
| Specifies the effectivity type option More... | |
| enum | ToUnitType { StockOut, OpenEnd } |
| Specifies option for range effectivity value's toUnit. More... | |
Public Member Functions | |
| unsafe void | AddUnitEffectivity (int fromUnit, int toUnit) |
| Adds specified discrete or range effectivity values to the builder. More... | |
| unsafe void | AddUnitEffectivity (int fromUnit, NXOpen.EffectivityConditionBuilder.ToUnitType toUnitType) |
| Adds specified range effectivity value to the builder. More... | |
| unsafe void | RemoveUnitEffectivity (int fromUnit, int toUnit) |
| Removes specified existing range effectivity values from the builder. More... | |
| unsafe void | RemoveUnitEffectivity (int fromUnit, NXOpen.EffectivityConditionBuilder.ToUnitType toUnitType) |
| Removes specified existing range unit effectivity which has toUnit value either NXOpen.EffectivityConditionBuilder.ToUnitType.StockOut or NXOpen.EffectivityConditionBuilder.ToUnitType.OpenEnd repectively. More... | |
| unsafe void | RegisterBasicEffectivityBuilder (NXOpen.BasicEffectivityBuilder beBuilder) |
| 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. More... | |
 Public Member Functions inherited from NXOpen.Builder | |
| unsafe NXOpen.NXObject | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| unsafe void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| unsafe NXOpen.NXObject[] | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| unsafe NXOpen.NXObject | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| unsafe void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| unsafe bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Properties | |
| unsafe string | EffectivityFormula [get] |
| Returns the string representation of effectivity More... | |
| unsafe NXOpen.EffectivityConditionBuilder.EffectivityConditionType | EffectivityType [get, set] |
| Returns or sets the effectivity type More... | |
Detailed Description
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 |
Created in NX8.5.0
Member Enumeration Documentation
Specifies option for range effectivity value's toUnit.
This enumeration is valid only for the effectivity type NXOpen.EffectivityConditionBuilder.EffectivityConditionType.UnitRange
| Enumerator | |
|---|---|
| StockOut |
Sets stock out unit as toUnit effectivity range |
| OpenEnd |
Sets open end unit as toUnit for effectivity range |
Member Function Documentation
| unsafe void NXOpen.EffectivityConditionBuilder.AddUnitEffectivity | ( | int | fromUnit, |
| int | toUnit | ||
| ) |
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.
Created in NX8.5.0
License requirements: None.
- Parameters
-
fromUnit toUnit
| unsafe void NXOpen.EffectivityConditionBuilder.AddUnitEffectivity | ( | int | fromUnit, |
| NXOpen.EffectivityConditionBuilder.ToUnitType | toUnitType | ||
| ) |
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.EffectivityConditionBuilder.ToUnitType.StockOut or NXOpen.EffectivityConditionBuilder.ToUnitType.OpenEnd respectively. This method is valid only for effectivity type NXOpen.EffectivityConditionBuilder.EffectivityConditionType.UnitRange .
Created in NX8.5.0
License requirements: None.
- Parameters
-
fromUnit toUnitType
| unsafe void NXOpen.EffectivityConditionBuilder.RegisterBasicEffectivityBuilder | ( | NXOpen.BasicEffectivityBuilder | beBuilder | ) |
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.
Created in NX8.5.0
License requirements: None.
- Parameters
-
beBuilder
| unsafe void NXOpen.EffectivityConditionBuilder.RemoveUnitEffectivity | ( | int | fromUnit, |
| int | toUnit | ||
| ) |
Removes specified existing range effectivity values from the builder.
To remove single discrete unit value, pass fromUnit and toUnit as same.
Created in NX8.5.0
License requirements: None.
- Parameters
-
fromUnit toUnit
| unsafe void NXOpen.EffectivityConditionBuilder.RemoveUnitEffectivity | ( | int | fromUnit, |
| NXOpen.EffectivityConditionBuilder.ToUnitType | toUnitType | ||
| ) |
Removes specified existing range unit effectivity which has toUnit value either NXOpen.EffectivityConditionBuilder.ToUnitType.StockOut or NXOpen.EffectivityConditionBuilder.ToUnitType.OpenEnd repectively.
Created in NX8.5.0
License requirements: None.
- Parameters
-
fromUnit toUnitType
Property Documentation
|
get |
Returns the string representation of effectivity
Created in NX8.5.0
License requirements: None.
|
getset |
Returns or sets the effectivity type
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
The documentation for this class was generated from the following file:
- dotnet_pool/EffectivityConditionBuilder.cs