BomListBuilder Class¶

class NXOpen.Tooling.BomListBuilder¶

Bases: NXOpen.Builder

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

New in version NX10.0.0.

Properties¶

Property	Description
BomListDataProvider	Returns the data provider of BOM
BomListType	Returns or sets the tree list shows which kind of components should be included in
BomTemplate	Returns or sets the template file of bom
SelectComponents	Returns the select component needed to get stocksize
Tag	Returns the Tag for this object.

Methods¶

Method	Description
AddBomData	Adds a new record into BOM list.
Commit	Commits any edits that have been applied to the builder.
CreatePartsList	Creates parts list for the assembly.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAttributeStrings	Gets all the attributes listed in the current template
GetColumn	Gets column number of given attribute
GetColumnAttribute	Gets the corresponding attribute name of given column.
GetColumnLabel	Gets the column label.
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.
GetPartOccs	Gets the corresponding part occurrences of given row.
GetRows	Gets all the row numbers in the given List
IgnoreComponents	Ignores the corresponding components of given row in the Hide List so that the components can not be exported to spreadsheet.
IgnoreRows	Ignores the given rows in the Hide List so that all the components of the rows can not be exported to spreadsheet.
ModifyBomData	Modifies BOM data
ParseBomTemplate	Parses the current BOM template.
PopulateBomListData	Populates BOM list data according to current template.
ShowComponents	Shows the corresponding components of given row in the BOM List so that the components can be exported to spreadsheet.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
ShowRows	Shows the given rows in the BOM List so that all the components of the rows can be exported to spreadsheet.
SortColumn	Sorts the given column.
UpdateEwBlankAttributes	Updates the blank attributes of electrodes in Electrode Design Application.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

BomListBuilderBomListSortOption Enumeration	Represents an enumeration indicating whether the sorting needs to be performed in ascending or descending order.
BomListBuilderBomListTypes Enumeration	Represents an index to components list type.

Property Detail¶

BomListDataProvider¶

BomListBuilder.BomListDataProvider¶

Returns the data provider of BOM

-------------------------------------

Getter Method

Signature BomListDataProvider

Returns:
Return type:	`NXOpen.Tooling.BomListDataProvider`

New in version NX11.0.0.

License requirements: None.

BomListType¶

BomListBuilder.BomListType¶

Returns or sets the tree list shows which kind of components should be included in

-------------------------------------

Getter Method

Signature BomListType

Returns:
Return type:	`NXOpen.Tooling.BomListBuilderBomListTypes`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BomListType

Parameters:	bomListType (`NXOpen.Tooling.BomListBuilderBomListTypes`) –

New in version 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”)

BomTemplate¶

BomListBuilder.BomTemplate¶

Returns or sets the template file of bom

-------------------------------------

Getter Method

Signature BomTemplate

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BomTemplate

Parameters:	bomTemplate (str) –

New in version 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”)

SelectComponents¶

BomListBuilder.SelectComponents¶

Returns the select component needed to get stocksize

-------------------------------------

Getter Method

Signature SelectComponents

Returns:
Return type:	`NXOpen.Assemblies.SelectComponentList`

New in version NX10.0.0.

License requirements: None.

Method Detail¶

AddBomData¶

BomListBuilder.AddBomData¶

Adds a new record into BOM list.

Signature AddBomData(partOccs, dataStrings)

Parameters:	partOccs (list of `NXOpen.Assemblies.Component`) – The part occurrences to add into BOM. Sets NULL to add the current display part into BOM list. dataStrings (list of str) – The BOM data.

New in version 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”)

CreatePartsList¶

BomListBuilder.CreatePartsList¶

Creates parts list for the assembly.

Signature CreatePartsList(columnWidths, point)

Parameters:	columnWidths (list of int) – The widths of each column. point (`NXOpen.Point3d`) – The position of parts list.
Returns:	The created parts list.
Return type:	`NXOpen.DisplayableObject`

New in version 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”)

GetAttributeStrings¶

BomListBuilder.GetAttributeStrings¶

Gets all the attributes listed in the current template

Signature GetAttributeStrings()

Returns:	Attribute strings.
Return type:	list of str

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use Tooling.BomListBuilder.GetColumnAttribute() instead.

License requirements: None.

GetColumn¶

BomListBuilder.GetColumn¶

Gets column number of given attribute

Signature GetColumn(attrString)

Parameters:	attrString (str) –

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use Tooling.BomListBuilder.GetColumnAttribute() instead.

License requirements: None.

GetColumnAttribute¶

BomListBuilder.GetColumnAttribute¶

Gets the corresponding attribute name of given column.

Signature GetColumnAttribute(columnID)

Parameters:	columnID (int) – Column index
Returns:	Column attribute
Return type:	str

New in version NX11.0.0.

License requirements: None.

GetColumnLabel¶

BomListBuilder.GetColumnLabel¶

Gets the column label.

Signature GetColumnLabel(columnID)

Parameters:	columnID (int) – Column index
Returns:	Column Label
Return type:	str

New in version NX11.0.0.

License requirements: None.

GetPartOccs¶

BomListBuilder.GetPartOccs¶

Gets the corresponding part occurrences of given row.

Signature GetPartOccs(rowID)

Parameters:	rowID (int) –
Returns:	The corresponding part occurrences of given row.
Return type:	list of `NXOpen.Assemblies.Component`

New in version NX10.0.0.

License requirements: None.

GetRows¶

BomListBuilder.GetRows¶

Gets all the row numbers in the given List

Signature GetRows(bomListType)

Parameters:	bomListType (`NXOpen.Tooling.BomListBuilderBomListTypes`) –
Returns:	All row numbers in the given list
Return type:	list of int

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use Tooling.BomListDataProvider.RowCount() instead.

License requirements: None.

IgnoreComponents¶

BomListBuilder.IgnoreComponents¶

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

Signature IgnoreComponents(rowID, partOccs)

Parameters:	rowID (int) – partOccs (list of `NXOpen.Assemblies.Component`) – The part occurrences to be ignored in Hide List. Sets NULL to ignore all part occurrences in given row in Hide List.

New in version 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”)

IgnoreRows¶

BomListBuilder.IgnoreRows¶

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

Signature IgnoreRows(rowIDs)

Parameters:	rowIDs (list of int) –

New in version 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”)

ModifyBomData¶

BomListBuilder.ModifyBomData¶

Modifies BOM data

Signature ModifyBomData(rowNumber, columnNumber, userString)

Parameters:	rowNumber (int) – columnNumber (int) – userString (str) –

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use Tooling.BomListDataProvider.SetString() instead.

License requirements: None.

ParseBomTemplate¶

BomListBuilder.ParseBomTemplate¶

Parses the current BOM template.

Use this function to populate data in data provider of BOM.

Signature ParseBomTemplate()

New in version 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”)

PopulateBomListData¶

BomListBuilder.PopulateBomListData¶

Populates BOM list data according to current template.

Signature PopulateBomListData()

New in version 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”)

ShowComponents¶

BomListBuilder.ShowComponents¶

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

Signature ShowComponents(rowID, partOccs)

Parameters:	rowID (int) – partOccs (list of `NXOpen.Assemblies.Component`) – The part occurrences to be shown in BOM List. Sets NULL show all part occurrences in given row in BOM List.

New in version 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”)

ShowRows¶

BomListBuilder.ShowRows¶

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

Signature ShowRows(rowIDs)

Parameters:	rowIDs (list of int) –

New in version 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”)

SortColumn¶

BomListBuilder.SortColumn¶

Sorts the given column.

Signature SortColumn(columnID, order)

Parameters:	columnID (int) – order (`NXOpen.Tooling.BomListBuilderBomListSortOption`) –

New in version 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”)

UpdateEwBlankAttributes¶

BomListBuilder.UpdateEwBlankAttributes¶

Updates the blank attributes of electrodes in Electrode Design Application.

Signature UpdateEwBlankAttributes()

New in version 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”)

Validate¶

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

BomListBuilder Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

BomListDataProvider¶

BomListType¶

BomTemplate¶

SelectComponents¶

Method Detail¶

AddBomData¶

CreatePartsList¶

GetAttributeStrings¶

GetColumn¶

GetColumnAttribute¶

GetColumnLabel¶

GetPartOccs¶

GetRows¶

IgnoreComponents¶

IgnoreRows¶

ModifyBomData¶

ParseBomTemplate¶

PopulateBomListData¶

ShowComponents¶

ShowRows¶

SortColumn¶

UpdateEwBlankAttributes¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics