BomBuilder Class¶
-
class
NXOpen.Tooling.BomBuilder¶ Bases:
NXOpen.BuilderRepresents a Tooling::BomBuilder builder
To create a new instance of this class, use
NXOpen.Tooling.BomCollection.CreateBomBuilder()Default values.
Property Value EnumCompList Bom New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| EnumCompList | Returns or sets the tree list shows which kind of components should be included in |
| EnumCylinderType | Returns or sets the cylinder type may be used to generate a cylinder for the stock size |
| EnumStockType | Returns or sets the stock shape will be generated, it can be a box or cylinder |
| IntegerPrecision | Returns or sets the size precision for the stock |
| SelectComponent | Returns the select component needed to get stocksize |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| 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. |
| 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¶
| BomBuilderCircle Enumeration | Represents an index to the base circle type of cylinder shape. |
| BomBuilderShape Enumeration | Represents an index to the shape of stock size. |
| BomBuilderTreeList Enumeration | Represents an index to components list type. |
Property Detail¶
EnumCompList¶
-
BomBuilder.EnumCompList¶ Returns or sets the tree list shows which kind of components should be included in
-------------------------------------Getter Method
Signature
EnumCompListReturns: Return type: NXOpen.Tooling.BomBuilderTreeListNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EnumCompListParameters: enumCompList ( NXOpen.Tooling.BomBuilderTreeList) –New in version NX6.0.0.
License requirements: None.
EnumCylinderType¶
-
BomBuilder.EnumCylinderType¶ Returns or sets the cylinder type may be used to generate a cylinder for the stock size
-------------------------------------Getter Method
Signature
EnumCylinderTypeReturns: Return type: NXOpen.Tooling.BomBuilderCircleNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EnumCylinderTypeParameters: enumCylinderType ( NXOpen.Tooling.BomBuilderCircle) –New in version NX6.0.0.
License requirements: None.
EnumStockType¶
-
BomBuilder.EnumStockType¶ Returns or sets the stock shape will be generated, it can be a box or cylinder
-------------------------------------Getter Method
Signature
EnumStockTypeReturns: Return type: NXOpen.Tooling.BomBuilderShapeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EnumStockTypeParameters: enumStockType ( NXOpen.Tooling.BomBuilderShape) –New in version NX6.0.0.
License requirements: None.
IntegerPrecision¶
-
BomBuilder.IntegerPrecision¶ Returns or sets the size precision for the stock
-------------------------------------Getter Method
Signature
IntegerPrecisionReturns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IntegerPrecisionParameters: integerPrecision (int) – New in version NX6.0.0.
License requirements: None.
SelectComponent¶
-
BomBuilder.SelectComponent¶ Returns the select component needed to get stocksize
-------------------------------------Getter Method
Signature
SelectComponentReturns: Return type: NXOpen.SelectPartListNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
BomBuilder.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.