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

Inheritance diagram for NXOpen::Tooling::BomListBuilder:

Public Types
enum	BomListSortOption { BomListSortOptionUnsorted, BomListSortOptionAscending, BomListSortOptionDescending }
	Represents an enumeration indicating whether the sorting needs to be performed in ascending or descending order. More...

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

Public Member Functions
void	AddBomData (const std::vector< NXOpen::Assemblies::Component * > &partOccs, std::vector< NXString > &dataStrings)
	Adds a new record into BOM list. More...

NXOpen::Tooling::BomListDataProvider *	BomListDataProvider ()
	Returns the data provider of BOM Created in NX11.0.0. More...

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...

NXOpen::DisplayableObject *	CreatePartsList (const std::vector< int > &columnWidths, const NXOpen::Point3d &point)
	Creates parts list for the assembly. More...

std::vector< NXString >	GetAttributeStrings ()
	Gets all the attributes listed in the current template. More...

void	GetColumn (const NXString &attrString)
	Gets column number of given attribute More...

void	GetColumn (const char *attrString)
	Gets column number of given attribute More...

NXString	GetColumnAttribute (int columnID)
	Gets the corresponding attribute name of given column. More...

NXString	GetColumnLabel (int columnID)
	Gets the column label. More...

std::vector < NXOpen::Assemblies::Component * >	GetPartOccs (int rowID)
	Gets the corresponding part occurrences 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 rowID, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
	Ignores the corresponding components of given row in the Hide List so that the components can not be exported to spreadsheet. More...

void	IgnoreRows (const std::vector< int > &rowIDs)
	Ignores the given rows in the Hide List so that all the components of the rows can not be exported to spreadsheet. More...

void	ModifyBomData (int rowNumber, int columnNumber, const NXString &userString)
	Modifies BOM data More...

void	ModifyBomData (int rowNumber, int columnNumber, const char *userString)
	Modifies BOM data More...

void	ParseBomTemplate ()
	Parses the current BOM template. More...

void	PopulateBomListData ()
	Populates BOM list data according to current template. More...

NXOpen::Assemblies::SelectComponentList *	SelectComponents ()
	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 rowID, const std::vector< NXOpen::Assemblies::Component * > &partOccs)
	Shows the corresponding components of given row in the BOM List so that the components can be exported to spreadsheet. More...

void	ShowRows (const std::vector< int > &rowIDs)
	Shows the given rows in the BOM List so that all the components of the rows can be exported to spreadsheet. More...

void	SortColumn (int columnID, NXOpen::Tooling::BomListBuilder::BomListSortOption order)
	Sorts the given column. More...

void	UpdateEwBlankAttributes ()
	Updates the blank attributes of electrodes in Electrode Design Application. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

enum NXOpen::Tooling::BomListBuilder::BomListSortOption

Represents an enumeration indicating whether the sorting needs to be performed in ascending or descending order.

Enumerator
BomListSortOptionUnsorted	Unsorted.
BomListSortOptionAscending	Ascending.
BomListSortOptionDescending	Descending.

enum NXOpen::Tooling::BomListBuilder::BomListTypes

Represents an index to components list type.

Enumerator
BomListTypesBomList	A list includes components in BOM.
BomListTypesHideList	A list includes hidden components.

Member Function Documentation

void NXOpen::Tooling::BomListBuilder::AddBomData	(	const std::vector< NXOpen::Assemblies::Component * > &	partOccs,
		std::vector< NXString > &	dataStrings
	)

Adds a new record into BOM list.

Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

partOccs	The part occurrences to add into BOM. Sets NULL to add the current display part into BOM list.
dataStrings	The BOM data.

NXOpen::Tooling::BomListDataProvider* NXOpen::Tooling::BomListBuilder::BomListDataProvider ( )

Returns the data provider of BOM
Created in NX11.0.0.

License requirements : None

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

NXOpen::DisplayableObject* NXOpen::Tooling::BomListBuilder::CreatePartsList	(	const std::vector< int > &	columnWidths,
		const NXOpen::Point3d &	point
	)

Creates parts list for the assembly.

Returns: The created parts list.
Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

columnWidths	The widths of each column.
point	The position of parts list.

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

Gets all the attributes listed in the current template.

Returns: Attribute strings.

Deprecated:: Deprecated in NX11.0.0. Use Tooling::BomListBuilder::GetColumnAttribute instead.

Created in NX10.0.0.

License requirements : None

void NXOpen::Tooling::BomListBuilder::GetColumn ( const NXString & attrString )

Gets column number of given attribute

Deprecated:: Deprecated in NX11.0.0.

Use Tooling::BomListBuilder::GetColumnAttribute instead.

Created in NX10.0.0.

License requirements : None

Parameters

attrString attrstring

void NXOpen::Tooling::BomListBuilder::GetColumn ( const char * attrString )

Gets column number of given attribute

Deprecated:: Deprecated in NX11.0.0.

Use Tooling::BomListBuilder::GetColumnAttribute instead.

Created in NX10.0.0.

License requirements : None

Parameters

attrString attrstring

NXString NXOpen::Tooling::BomListBuilder::GetColumnAttribute ( int columnID )

Gets the corresponding attribute name of given column.

Returns: Column attribute
Created in NX11.0.0.

License requirements : None

Parameters

columnID Column index

NXString NXOpen::Tooling::BomListBuilder::GetColumnLabel ( int columnID )

Gets the column label.

Returns: Column Label
Created in NX11.0.0.

License requirements : None

Parameters

columnID Column index

std::vector<NXOpen::Assemblies::Component *> NXOpen::Tooling::BomListBuilder::GetPartOccs ( int rowID )

Gets the corresponding part occurrences of given row.

Returns: The corresponding part occurrences of given row.
Created in NX10.0.0.

License requirements : None

Parameters

rowID rowid

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

Deprecated:: Deprecated in NX11.0.0. Use Tooling::BomListDataProvider::RowCount instead.

Created in NX10.0.0.

License requirements : None

Parameters

bomListType bomlisttype

void NXOpen::Tooling::BomListBuilder::IgnoreComponents	(	int	rowID,
		const std::vector< NXOpen::Assemblies::Component * > &	partOccs
	)

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

Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

rowID	rowid
partOccs	The part occurrences to be ignored in Hide List. Sets NULL to ignore all part occurrences in given row in Hide List.

void NXOpen::Tooling::BomListBuilder::IgnoreRows ( const std::vector< int > & rowIDs )

Ignores the given rows in the Hide List so that all the components of the rows can not be exported to spreadsheet.

Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

rowIDs rowids

void NXOpen::Tooling::BomListBuilder::ModifyBomData	(	int	rowNumber,
		int	columnNumber,
		const NXString &	userString
	)

Modifies BOM data

Deprecated:: Deprecated in NX11.0.0.

Use Tooling::BomListDataProvider::SetString instead.

Created in NX10.0.0.

License requirements : None

Parameters

rowNumber	rownumber
columnNumber	columnnumber
userString	userstring

void NXOpen::Tooling::BomListBuilder::ModifyBomData	(	int	rowNumber,
		int	columnNumber,
		const char *	userString
	)

Modifies BOM data

Deprecated:: Deprecated in NX11.0.0.

Use Tooling::BomListDataProvider::SetString instead.

Created in NX10.0.0.

License requirements : None

Parameters

rowNumber	rownumber
columnNumber	columnnumber
userString	userstring

void NXOpen::Tooling::BomListBuilder::ParseBomTemplate ( )

Parses the current BOM template.

Use this function to populate data in data provider of BOM.
Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

void NXOpen::Tooling::BomListBuilder::PopulateBomListData ( )

Populates BOM list data according to current template.

Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

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 : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

bomListType bomlisttype

void NXOpen::Tooling::BomListBuilder::SetBomTemplate ( const NXString & bomTemplate )

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

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

bomTemplate bomtemplate

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

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

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

bomTemplate bomtemplate

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

Shows the corresponding components of given row in the BOM List so that the components can be exported to spreadsheet.

Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

rowID	rowid
partOccs	The part occurrences to be shown in BOM List. Sets NULL show all part occurrences in given row in BOM List.

void NXOpen::Tooling::BomListBuilder::ShowRows ( const std::vector< int > & rowIDs )

Shows the given rows in the BOM List so that all the components of the rows can be exported to spreadsheet.

Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

rowIDs rowids

void NXOpen::Tooling::BomListBuilder::SortColumn	(	int	columnID,
		NXOpen::Tooling::BomListBuilder::BomListSortOption	order
	)

Sorts the given column.

Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters

columnID	columnid
order	order

void NXOpen::Tooling::BomListBuilder::UpdateEwBlankAttributes ( )

Updates the blank attributes of electrodes in Electrode Design Application.

Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

The documentation for this class was generated from the following file:

Tooling_BomListBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation