NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::BomBuilder Class Reference

Represents a Tooling::BomBuilder builder
To create a new instance of this class, use NXOpen::Tooling::BomCollection::CreateBomBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::BomBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Circle { CircleCircumcircle, CircleInscribedCircle }
 Represents an index to the base circle type of cylinder shape. More...
 
enum  Shape { ShapeRectangular, ShapeCircular }
 Represents an index to the shape of stock size. More...
 
enum  TreeList { TreeListBom, TreeListHide }
 Represents an index to components list type. More...
 

Public Member Functions

NXOpen::Tooling::BomBuilder::TreeList EnumCompList ()
 Returns the tree list shows which kind of components should be included in
Created in NX6.0.0. More...
 
NXOpen::Tooling::BomBuilder::Circle EnumCylinderType ()
 Returns the cylinder type may be used to generate a cylinder for the stock size
Created in NX6.0.0. More...
 
NXOpen::Tooling::BomBuilder::Shape EnumStockType ()
 Returns the stock shape will be generated, it can be a box or cylinder
Created in NX6.0.0. More...
 
int IntegerPrecision ()
 Returns the size precision for the stock
Created in NX6.0.0. More...
 
NXOpen::SelectPartListSelectComponent ()
 Returns the select component needed to get stocksize
Created in NX6.0.0. More...
 
void SetEnumCompList (NXOpen::Tooling::BomBuilder::TreeList enumCompList)
 Sets the tree list shows which kind of components should be included in
Created in NX6.0.0. More...
 
void SetEnumCylinderType (NXOpen::Tooling::BomBuilder::Circle enumCylinderType)
 Sets the cylinder type may be used to generate a cylinder for the stock size
Created in NX6.0.0. More...
 
void SetEnumStockType (NXOpen::Tooling::BomBuilder::Shape enumStockType)
 Sets the stock shape will be generated, it can be a box or cylinder
Created in NX6.0.0. More...
 
void SetIntegerPrecision (int integerPrecision)
 Sets the size precision for the stock
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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...
 

Detailed Description

Represents a Tooling::BomBuilder builder
To create a new instance of this class, use NXOpen::Tooling::BomCollection::CreateBomBuilder
Default values.

Property Value

EnumCompList

Bom


Created in NX6.0.0.

Member Enumeration Documentation

Represents an index to the base circle type of cylinder shape.

Enumerator
CircleCircumcircle 

Circumcircle.

CircleInscribedCircle 

Inscribed circle.

Represents an index to the shape of stock size.

Enumerator
ShapeRectangular 

The rectangular type.

ShapeCircular 

The circular type.

Represents an index to components list type.

Enumerator
TreeListBom 

A list includes components in BOM.

TreeListHide 

A list includes hidden components.

Member Function Documentation

NXOpen::Tooling::BomBuilder::TreeList NXOpen::Tooling::BomBuilder::EnumCompList ( )

Returns the tree list shows which kind of components should be included in
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::BomBuilder::Circle NXOpen::Tooling::BomBuilder::EnumCylinderType ( )

Returns the cylinder type may be used to generate a cylinder for the stock size
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::BomBuilder::Shape NXOpen::Tooling::BomBuilder::EnumStockType ( )

Returns the stock shape will be generated, it can be a box or cylinder
Created in NX6.0.0.



License requirements : None

int NXOpen::Tooling::BomBuilder::IntegerPrecision ( )

Returns the size precision for the stock
Created in NX6.0.0.



License requirements : None

NXOpen::SelectPartList* NXOpen::Tooling::BomBuilder::SelectComponent ( )

Returns the select component needed to get stocksize
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::BomBuilder::SetEnumCompList ( NXOpen::Tooling::BomBuilder::TreeList  enumCompList)

Sets the tree list shows which kind of components should be included in
Created in NX6.0.0.



License requirements : None

Parameters
enumCompListenumcomplist
void NXOpen::Tooling::BomBuilder::SetEnumCylinderType ( NXOpen::Tooling::BomBuilder::Circle  enumCylinderType)

Sets the cylinder type may be used to generate a cylinder for the stock size
Created in NX6.0.0.



License requirements : None

Parameters
enumCylinderTypeenumcylindertype
void NXOpen::Tooling::BomBuilder::SetEnumStockType ( NXOpen::Tooling::BomBuilder::Shape  enumStockType)

Sets the stock shape will be generated, it can be a box or cylinder
Created in NX6.0.0.



License requirements : None

Parameters
enumStockTypeenumstocktype
void NXOpen::Tooling::BomBuilder::SetIntegerPrecision ( int  integerPrecision)

Sets the size precision for the stock
Created in NX6.0.0.



License requirements : None

Parameters
integerPrecisionintegerprecision

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.