HoleTreatmentBuilder Class¶
-
class
NXOpen.Features.SheetMetal.HoleTreatmentBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderThe HoleTreatmentBuilder class is used to manage a builder object for a hole treatment in the flat pattern dialogs.
It includes properties and an enumeration type for a flag that indicates whether the global (flat pattern preferences) value is to be used, an enumeration type that indicates what type of hole treatment to apply, and an expression to indicate the diameter value associated with treatment type.
New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Diameter | Returns the hole diameter value associated with the treatment type |
| Tag | Returns the Tag for this object. |
| Treatment | Returns or sets the treatment type option menu value |
| UseGlobal | Returns or sets the use global toggle value |
Methods¶
| Method | Description |
|---|---|
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| HoleTreatmentBuilderTreatmentType Enumeration | Hole Treatment Type |
Property Detail¶
Diameter¶
-
HoleTreatmentBuilder.Diameter¶ Returns the hole diameter value associated with the treatment type
-------------------------------------Getter Method
Signature
DiameterReturns: Return type: NXOpen.ExpressionNew in version NX12.0.0.
License requirements: None.
Treatment¶
-
HoleTreatmentBuilder.Treatment¶ Returns or sets the treatment type option menu value
-------------------------------------Getter Method
Signature
TreatmentReturns: Return type: NXOpen.Features.SheetMetal.HoleTreatmentBuilderTreatmentTypeNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TreatmentParameters: treatmentType ( NXOpen.Features.SheetMetal.HoleTreatmentBuilderTreatmentType) –New in version NX12.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
UseGlobal¶
-
HoleTreatmentBuilder.UseGlobal¶ Returns or sets the use global toggle value
-------------------------------------Getter Method
Signature
UseGlobalReturns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseGlobalParameters: useGlobal (bool) – New in version NX12.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
Method Detail¶
Validate¶
-
HoleTreatmentBuilder.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.