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

Represents a NXOpen::Tooling::BomListBuilder builder. More...

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

Public Types

enum  BomListTypes { BomListTypesBomList, BomListTypesHideList }
 Represents an index to components list type. More...
 

Public Member Functions

NXOpen::Tooling::BomListBuilder::BomListTypes BomListType ()
 Returns the tree list shows which kind of components should be included in
Created in NX10.0.0. More...
 
NXString BomTemplate ()
 Returns the template file of bom
Created in NX10.0.0. More...
 
std::vector< NXStringGetAttributeStrings ()
 Gets all the attributes listed in the current template. More...
 
void GetColumn (const NXString &attrString)
 Gets column number of given attribute
Created in NX10.0.0. More...
 
void GetColumn (const char *attrString)
 Gets column number of given attribute
Created in NX10.0.0. More...
 
std::vector
< NXOpen::Assemblies::Component * > 
GetPartOccs (int rowNumber)
 Gets part occs of given row. More...
 
std::vector< int > GetRows (NXOpen::Tooling::BomListBuilder::BomListTypes bomListType)
 Gets all the row numbers in the given List. More...
 
void IgnoreComponents (int rowNumber, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
 Ignores components of given row in the Hide List so that the row can not be exported to excel. More...
 
void ModifyBomData (int rowNumber, int columnNumber, const NXString &userString)
 Modifies BOM data
Created in NX10.0.0. More...
 
void ModifyBomData (int rowNumber, int columnNumber, const char *userString)
 Modifies BOM data
Created in NX10.0.0. More...
 
void PopulateBomListData ()
 Populates BOM list data according to current template
Created in NX10.0.0. More...
 
NXOpen::Assemblies::SelectComponentListSelectComponents ()
 Returns the select component needed to get stocksize
Created in NX10.0.0. More...
 
void SetBomListType (NXOpen::Tooling::BomListBuilder::BomListTypes bomListType)
 Sets the tree list shows which kind of components should be included in
Created in NX10.0.0. More...
 
void SetBomTemplate (const NXString &bomTemplate)
 Sets the template file of bom
Created in NX10.0.0. More...
 
void SetBomTemplate (const char *bomTemplate)
 Sets the template file of bom
Created in NX10.0.0. More...
 
void ShowComponents (int rowNumber, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
 Shows components of given row in the BOM list so that the row can be exported to excel. 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 NXOpen::Tooling::BomListBuilder builder.


To create a new instance of this class, use NXOpen::Tooling::MoldwizardManager::CreateBomListBuilder
Default values.

Property Value

BomListType

BomList


Created in NX10.0.0.

Member Enumeration Documentation

Represents an index to components list type.

Enumerator
BomListTypesBomList 

A list includes components in BOM.

BomListTypesHideList 

A list includes hidden components.

Member Function Documentation

NXOpen::Tooling::BomListBuilder::BomListTypes NXOpen::Tooling::BomListBuilder::BomListType ( )

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



License requirements : None

NXString NXOpen::Tooling::BomListBuilder::BomTemplate ( )

Returns the template file of bom
Created in NX10.0.0.



License requirements : None

std::vector<NXString> NXOpen::Tooling::BomListBuilder::GetAttributeStrings ( )

Gets all the attributes listed in the current template.

Returns
Attribute strings.
Created in NX10.0.0.

License requirements : None
void NXOpen::Tooling::BomListBuilder::GetColumn ( const NXString attrString)

Gets column number of given attribute
Created in NX10.0.0.



License requirements : None

Parameters
attrString
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Tooling::BomListBuilder::GetColumn ( const char *  attrString)

Gets column number of given attribute
Created in NX10.0.0.



License requirements : None

Parameters
attrString
NOTE: The full Unicode character set is not supported for this parameter.
std::vector<NXOpen::Assemblies::Component *> NXOpen::Tooling::BomListBuilder::GetPartOccs ( int  rowNumber)

Gets part occs of given row.

Returns
The part occs of given row
Created in NX10.0.0.

License requirements : None
Parameters
rowNumberrownumber
std::vector<int> NXOpen::Tooling::BomListBuilder::GetRows ( NXOpen::Tooling::BomListBuilder::BomListTypes  bomListType)

Gets all the row numbers in the given List.

Returns
All row numbers in the given list
Created in NX10.0.0.

License requirements : None
Parameters
bomListTypebomlisttype
void NXOpen::Tooling::BomListBuilder::IgnoreComponents ( int  rowNumber,
const std::vector< NXOpen::Assemblies::Component * > &  partOccs 
)

Ignores components of given row in the Hide List so that the row can not be exported to excel.


Created in NX10.0.0.

License requirements : None

Parameters
rowNumberrownumber
partOccspartoccs
void NXOpen::Tooling::BomListBuilder::ModifyBomData ( int  rowNumber,
int  columnNumber,
const NXString userString 
)

Modifies BOM data
Created in NX10.0.0.



License requirements : None

Parameters
rowNumberrownumber
columnNumbercolumnnumber
userString
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Tooling::BomListBuilder::ModifyBomData ( int  rowNumber,
int  columnNumber,
const char *  userString 
)

Modifies BOM data
Created in NX10.0.0.



License requirements : None

Parameters
rowNumberrownumber
columnNumbercolumnnumber
userString
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Tooling::BomListBuilder::PopulateBomListData ( )

Populates BOM list data according to current template
Created in NX10.0.0.



License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::BomListBuilder::SelectComponents ( )

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



License requirements : None

void NXOpen::Tooling::BomListBuilder::SetBomListType ( NXOpen::Tooling::BomListBuilder::BomListTypes  bomListType)

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



License requirements : None

Parameters
bomListTypebomlisttype
void NXOpen::Tooling::BomListBuilder::SetBomTemplate ( const NXString bomTemplate)

Sets the template file of bom
Created in NX10.0.0.



License requirements : None

Parameters
bomTemplatebomtemplate
void NXOpen::Tooling::BomListBuilder::SetBomTemplate ( const char *  bomTemplate)

Sets the template file of bom
Created in NX10.0.0.



License requirements : None

Parameters
bomTemplatebomtemplate
void NXOpen::Tooling::BomListBuilder::ShowComponents ( int  rowNumber,
const std::vector< NXOpen::Assemblies::Component * > &  partOccs 
)

Shows components of given row in the BOM list so that the row can be exported to excel.


Created in NX10.0.0.

License requirements : None

Parameters
rowNumberrownumber
partOccspartoccs

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