NX Open C++ Reference Guide
|
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 { EffectivityConditionTypeUnit, EffectivityConditionTypeUnitRange } |
Specifies the effectivity type option. More... | |
enum | ToUnitType { ToUnitTypeStockOut, ToUnitTypeOpenEnd } |
Specifies option for range effectivity value's toUnit. More... | |
Public Member Functions | |
void | AddUnitEffectivity (int fromUnit, int toUnit) |
Adds specified discrete or range effectivity values to the builder. More... | |
void | AddUnitEffectivity (int fromUnit, NXOpen::EffectivityConditionBuilder::ToUnitType toUnitType) |
Adds specified range effectivity value to the builder. More... | |
NXString | EffectivityFormula () |
Returns the string representation of effectivity Created in NX8.5.0. More... | |
NXOpen::EffectivityConditionBuilder::EffectivityConditionType | EffectivityType () |
Returns the effectivity type Created in NX8.5.0. More... | |
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... | |
void | RemoveUnitEffectivity (int fromUnit, int toUnit) |
Removes specified existing range effectivity values from the builder. More... | |
void | RemoveUnitEffectivity (int fromUnit, NXOpen::EffectivityConditionBuilder::ToUnitType toUnitType) |
Removes specified existing range unit effectivity which has toUnit value either NXOpen::EffectivityConditionBuilder::ToUnitTypeStockOut or NXOpen::EffectivityConditionBuilder::ToUnitTypeOpenEnd repectively. More... | |
void | SetEffectivityType (NXOpen::EffectivityConditionBuilder::EffectivityConditionType selectTypeEffectivity) |
Sets the effectivity type Created in NX8.5.0. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
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.
Specifies option for range effectivity value's toUnit.
This enumeration is valid only for the effectivity type NXOpen::EffectivityConditionBuilder::EffectivityConditionTypeUnitRange
Enumerator | |
---|---|
ToUnitTypeStockOut |
Sets stock out unit as toUnit effectivity range. |
ToUnitTypeOpenEnd |
Sets open end unit as toUnit for effectivity range. |
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
fromUnit | fromunit |
toUnit | tounit |
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::ToUnitTypeStockOut or NXOpen::EffectivityConditionBuilder::ToUnitTypeOpenEnd respectively. This method is valid only for effectivity type NXOpen::EffectivityConditionBuilder::EffectivityConditionTypeUnitRange .
Created in NX8.5.0.
License requirements : None
fromUnit | fromunit |
toUnitType | tounittype |
NXString NXOpen::EffectivityConditionBuilder::EffectivityFormula | ( | ) |
Returns the string representation of effectivity
Created in NX8.5.0.
License requirements : None
NXOpen::EffectivityConditionBuilder::EffectivityConditionType NXOpen::EffectivityConditionBuilder::EffectivityType | ( | ) |
Returns the effectivity type
Created in NX8.5.0.
License requirements : None
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
beBuilder | bebuilder |
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
fromUnit | fromunit |
toUnit | tounit |
void NXOpen::EffectivityConditionBuilder::RemoveUnitEffectivity | ( | int | fromUnit, |
NXOpen::EffectivityConditionBuilder::ToUnitType | toUnitType | ||
) |
Removes specified existing range unit effectivity which has toUnit value either NXOpen::EffectivityConditionBuilder::ToUnitTypeStockOut or NXOpen::EffectivityConditionBuilder::ToUnitTypeOpenEnd repectively.
Created in NX8.5.0.
License requirements : None
fromUnit | fromunit |
toUnitType | tounittype |
void NXOpen::EffectivityConditionBuilder::SetEffectivityType | ( | NXOpen::EffectivityConditionBuilder::EffectivityConditionType | selectTypeEffectivity | ) |
Sets the effectivity type
Created in NX8.5.0.
License requirements : None
selectTypeEffectivity | selecttypeeffectivity |