DatumIconBuilder Class¶
-
class
NXOpen.Weld.DatumIconBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.Weld.DatumIconBuilderclass used to control the part navigator icon for Datum Pin and Surface Locators.This class is used to set the Datum Surface or Datum Pin icon, but never both at the same time. If the icon is not being set for a feature, that feature will be set to None. See example in DatumIconCallback.cxx in ugweld/samples kit. .. versionadded:: NX9.0.0
Properties¶
| Property | Description |
|---|---|
| CustomType | Returns the custom datum type from the customer defaults that was used. |
| DatumPin | Returns the DatumPin feature. |
| DatumSurface | Returns the DatumSurface feature. |
| Derived | Returns the indicator if this datum was derived from another datum. |
| IconName | Returns or sets the bit map name for the icon to be used. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
CustomType¶
-
DatumIconBuilder.CustomType¶ Returns the custom datum type from the customer defaults that was used.
-------------------------------------Getter Method
Signature
CustomTypeReturns: Return type: NXOpen.Weld.DatumCommonBuilderCustomTypesNew in version NX9.0.0.
License requirements: None.
DatumPin¶
-
DatumIconBuilder.DatumPin¶ Returns the DatumPin feature.
This will be None if setting the icon for a DatumSurface
-------------------------------------Getter Method
Signature
DatumPinReturns: NXOpen.Weld.DatumPinto assign icon to.Return type: NXOpen.Weld.DatumPinNew in version NX9.0.0.
License requirements: None.
DatumSurface¶
-
DatumIconBuilder.DatumSurface¶ Returns the DatumSurface feature.
This will be None if setting the icon for a DatumPin.
-------------------------------------Getter Method
Signature
DatumSurfaceReturns: NXOpen.Weld.DatumSurfaceto assign icon to.Return type: NXOpen.Weld.DatumSurfaceNew in version NX9.0.0.
License requirements: None.
Derived¶
-
DatumIconBuilder.Derived¶ Returns the indicator if this datum was derived from another datum.
-------------------------------------Getter Method
Signature
DerivedReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
IconName¶
-
DatumIconBuilder.IconName¶ Returns or sets the bit map name for the icon to be used.
If the bit map cannot be found a default one will be used.
-------------------------------------Getter Method
Signature
IconNameReturns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IconNameParameters: iconName (str) – New in version NX9.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
DatumIconBuilder.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.