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

Builder for Bill of Material functionality used in Routing. More...

Inheritance diagram for NXOpen::Annotations::BillOfMaterialBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DetailLevelType { DetailLevelTypeSummary, DetailLevelTypeItemized }
 The options specify the detail level type. More...
 
enum  FabricationNumberingType { FabricationNumberingTypeSequential, FabricationNumberingTypeOriginal }
 The options specify the fabrication numbering type. More...
 
enum  StockLengthType { StockLengthTypeSingleSum, StockLengthTypeListEach }
 The options specify the stock length type. More...
 

Public Member Functions

NXOpen::Annotations::BillOfMaterialBuilder::DetailLevelType DetailLevel ()
 Returns the value that specifies the detail level type. More...
 
NXOpen::Annotations::BillOfMaterialBuilder::FabricationNumberingType FabricationNumbering ()
 Returns the value that specifies the fabrication numbering. More...
 
bool IncludeComponents ()
 Returns the value that specifies whether include components. More...
 
bool IncludeGaskNutBolts ()
 Returns the value that specifies whether include gask, nut and bolts. More...
 
bool IncludeOverStock ()
 Returns the value that specifies whether include overstock. More...
 
bool IncludeStock ()
 Returns the value that specifies whether to include stock. More...
 
bool IncludeWireStock ()
 Returns the value that specifies whether include wire stock. More...
 
void SetDetailLevel (NXOpen::Annotations::BillOfMaterialBuilder::DetailLevelType detailLevel)
 Sets the value that specifies the detail level type. More...
 
void SetFabricationNumbering (NXOpen::Annotations::BillOfMaterialBuilder::FabricationNumberingType fabricationNumbering)
 Sets the value that specifies the fabrication numbering. More...
 
void SetIncludeComponents (bool includeComponents)
 Sets the value that specifies whether include components. More...
 
void SetIncludeGaskNutBolts (bool includeGaskNutBolts)
 Sets the value that specifies whether include gask, nut and bolts. More...
 
void SetIncludeOverStock (bool includeOverStock)
 Sets the value that specifies whether include overstock. More...
 
void SetIncludeStock (bool includeStock)
 Sets the value that specifies whether to include stock. More...
 
void SetIncludeWireStock (bool includeWireStock)
 Sets the value that specifies whether include wire stock. More...
 
void SetStockLength (NXOpen::Annotations::BillOfMaterialBuilder::StockLengthType stockLength)
 Sets the value that specifies the stock length type. More...
 
void SetStockPieceCount (bool stockPieceCount)
 Sets the value that specifies whether include report cout of stock pieces. More...
 
NXOpen::Annotations::BillOfMaterialBuilder::StockLengthType StockLength ()
 Returns the value that specifies the stock length type. More...
 
bool StockPieceCount ()
 Returns the value that specifies whether include report cout of stock pieces. 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

Builder for Bill of Material functionality used in Routing.

This class queries and sets settings specific to Routing Bill of Material.


Created in NX9.0.0.

Member Enumeration Documentation

The options specify the detail level type.

Enumerator
DetailLevelTypeSummary 

summary

DetailLevelTypeItemized 

itemized

The options specify the fabrication numbering type.

Enumerator
FabricationNumberingTypeSequential 

sequential

FabricationNumberingTypeOriginal 

original

The options specify the stock length type.

Enumerator
StockLengthTypeSingleSum 

single sum

StockLengthTypeListEach 

list each

Member Function Documentation

NXOpen::Annotations::BillOfMaterialBuilder::DetailLevelType NXOpen::Annotations::BillOfMaterialBuilder::DetailLevel ( )

Returns the value that specifies the detail level type.


Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::BillOfMaterialBuilder::FabricationNumberingType NXOpen::Annotations::BillOfMaterialBuilder::FabricationNumbering ( )

Returns the value that specifies the fabrication numbering.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::IncludeComponents ( )

Returns the value that specifies whether include components.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::IncludeGaskNutBolts ( )

Returns the value that specifies whether include gask, nut and bolts.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::IncludeOverStock ( )

Returns the value that specifies whether include overstock.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::IncludeStock ( )

Returns the value that specifies whether to include stock.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::IncludeWireStock ( )

Returns the value that specifies whether include wire stock.


Created in NX9.0.0.

License requirements : None

void NXOpen::Annotations::BillOfMaterialBuilder::SetDetailLevel ( NXOpen::Annotations::BillOfMaterialBuilder::DetailLevelType  detailLevel)

Sets the value that specifies the detail level type.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
detailLeveldetaillevel
void NXOpen::Annotations::BillOfMaterialBuilder::SetFabricationNumbering ( NXOpen::Annotations::BillOfMaterialBuilder::FabricationNumberingType  fabricationNumbering)

Sets the value that specifies the fabrication numbering.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
fabricationNumberingfabricationnumbering
void NXOpen::Annotations::BillOfMaterialBuilder::SetIncludeComponents ( bool  includeComponents)

Sets the value that specifies whether include components.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
includeComponentsincludecomponents
void NXOpen::Annotations::BillOfMaterialBuilder::SetIncludeGaskNutBolts ( bool  includeGaskNutBolts)

Sets the value that specifies whether include gask, nut and bolts.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
includeGaskNutBoltsincludegasknutbolts
void NXOpen::Annotations::BillOfMaterialBuilder::SetIncludeOverStock ( bool  includeOverStock)

Sets the value that specifies whether include overstock.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
includeOverStockincludeoverstock
void NXOpen::Annotations::BillOfMaterialBuilder::SetIncludeStock ( bool  includeStock)

Sets the value that specifies whether to include stock.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
includeStockincludestock
void NXOpen::Annotations::BillOfMaterialBuilder::SetIncludeWireStock ( bool  includeWireStock)

Sets the value that specifies whether include wire stock.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
includeWireStockincludewirestock
void NXOpen::Annotations::BillOfMaterialBuilder::SetStockLength ( NXOpen::Annotations::BillOfMaterialBuilder::StockLengthType  stockLength)

Sets the value that specifies the stock length type.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
stockLengthstocklength
void NXOpen::Annotations::BillOfMaterialBuilder::SetStockPieceCount ( bool  stockPieceCount)

Sets the value that specifies whether include report cout of stock pieces.


Created in NX9.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
stockPieceCountstockpiececount
NXOpen::Annotations::BillOfMaterialBuilder::StockLengthType NXOpen::Annotations::BillOfMaterialBuilder::StockLength ( )

Returns the value that specifies the stock length type.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BillOfMaterialBuilder::StockPieceCount ( )

Returns the value that specifies whether include report cout of stock pieces.


Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Annotations::BillOfMaterialBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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