BomListDataProvider Class¶

class NXOpen.Tooling.BomListDataProvider¶

Bases: NXOpen.TaggedObject, NXOpen.ITableEditorDataProvider

Provides basic data for BOM List.

When Builder.Commit() is called None will be returned.

To create a new instance of this class, use NXOpen.Tooling.MoldwizardManager.CreateBomListDataProvider()

New in version NX11.0.0.

Properties¶

Property	Description
ColumnCount	Returns or sets the number of columns in the table
RowCount	Returns or sets the number of rows in the table
Tag	Returns the Tag for this object.

Methods¶

Method	Description
Destroy	Deletes the data provider.
GetBoolean	Gets the boolean data at a particular location in the table.
GetDouble	Gets the double data at a particular location in the table.
GetInteger	Gets the integer data at a particular location in the table.
GetString	Gets the string data at a particular location in the table.
SetBoolean	Sets boolean data at a particular location in the table.
SetDouble	Sets double data at a particular location in the table.
SetInteger	Sets integer data at a particular location in the table.
SetString	Sets string data at a particular location in the table.
UnsetValue	Unsets the data at a particular location in the table.

Enumerations¶

BomListDataProviderExportedStatus Enumeration

Represents the exported status of a cell.

Property Detail¶

ColumnCount¶

BomListDataProvider.ColumnCount¶

Returns or sets the number of columns in the table

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

Getter Method

Signature ColumnCount

Returns:	the number of columns in the table
Return type:	int

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ColumnCount

Parameters:	columnCount (int) – the number of columns in the table

New in version NX10.0.0.

License requirements: None.

RowCount¶

BomListDataProvider.RowCount¶

Returns or sets the number of rows in the table

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

Getter Method

Signature RowCount

Returns:	the number of rows in the table
Return type:	int

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature RowCount

Parameters:	rowCount (int) – the number of rows in the table

New in version NX10.0.0.

License requirements: None.

Method Detail¶

Destroy¶

BomListDataProvider.Destroy¶

Deletes the data provider.

This method should always be called when the data provider is no longer needed.

Signature Destroy()

New in version NX11.0.0.

License requirements: None.

GetBoolean¶

BomListDataProvider.GetBoolean¶

Gets the boolean data at a particular location in the table.

Signature GetBoolean(row, column)

Parameters:	row (int) – the rows to query column (int) – the column to query
Returns:	the boolean data at the row and column specified
Return type:	bool

New in version NX11.0.0.

License requirements: None.

GetDouble¶

BomListDataProvider.GetDouble¶

Gets the double data at a particular location in the table.

Signature GetDouble(row, column)

Parameters:	row (int) – the rows to query column (int) – the column to query
Returns:	a tuple
Return type:	A tuple consisting of (doubleData, isUnassigned) doubleData is a float. the double data at the row and column specified isUnassigned is a bool. is the value unassigned

New in version NX11.0.0.

License requirements: None.

GetInteger¶

BomListDataProvider.GetInteger¶

Gets the integer data at a particular location in the table.

Signature GetInteger(row, column)

Parameters:	row (int) – the rows to query column (int) – the column to query
Returns:	a tuple
Return type:	A tuple consisting of (integerData, isUnassigned) integerData is a int. the integer data at the row and column specified isUnassigned is a bool. is the value unassigned

New in version NX11.0.0.

License requirements: None.

GetString¶

BomListDataProvider.GetString¶

Gets the string data at a particular location in the table.

Signature GetString(row, column)

Parameters:	row (int) – the rows to query column (int) – the column to query
Returns:	the string data at the row and column specified
Return type:	str

New in version NX10.0.0.

License requirements: None.

SetBoolean¶

BomListDataProvider.SetBoolean¶

Overloaded method SetBoolean

SetBoolean(rows, column, booleanData)
SetBoolean(rows, column, booleanData)

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

Sets boolean data at a particular location in the table.

Signature SetBoolean(rows, column, booleanData)

Parameters:	rows (int) – the row to set column (int) – the column to set booleanData (bool) – the boolean data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Sets boolean data on a range of table cells in a specified column. Returns whether any data was successfully set.

Signature SetBoolean(rows, column, booleanData)

Parameters:	rows (list of int) – the rows to set column (int) – the column to be set booleanData (bool) – the boolean data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

SetDouble¶

BomListDataProvider.SetDouble¶

Overloaded method SetDouble

SetDouble(rows, column, doubleData)
SetDouble(rows, column, doubleData)

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

Sets double data at a particular location in the table.

Signature SetDouble(rows, column, doubleData)

Parameters:	rows (int) – the row to set column (int) – the column to set doubleData (float) – the double data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Sets double data on a range of table cells in a specified column. Returns whether any data was successfully set.

Signature SetDouble(rows, column, doubleData)

Parameters:	rows (list of int) – the rows to set column (int) – the column to be set doubleData (float) – the double data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

SetInteger¶

BomListDataProvider.SetInteger¶

Overloaded method SetInteger

SetInteger(rows, column, integerData)
SetInteger(rows, column, integerData)

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

Sets integer data at a particular location in the table.

Signature SetInteger(rows, column, integerData)

Parameters:	rows (int) – the row to set column (int) – the column to set integerData (int) – the integer data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Sets integer data on a range of table cells in a specified column. Returns whether any data was successfully set.

Signature SetInteger(rows, column, integerData)

Parameters:	rows (list of int) – the rows to set column (int) – the column to be set integerData (int) – the integer data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

SetString¶

BomListDataProvider.SetString¶

Overloaded method SetString

SetString(rows, column, stringData)
SetString(rows, column, stringData)

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

Sets string data at a particular location in the table.

Signature SetString(rows, column, stringData)

Parameters:	rows (int) – the row to set column (int) – the column to set stringData (str) – the string data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Sets string data on a range of table cells in a specified column. Returns whether any data was successfully set.

Signature SetString(rows, column, stringData)

Parameters:	rows (list of int) – the rows to set column (int) – the column to be set stringData (str) – the string data to set
Returns:	whether or not the data was successfully set.
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

UnsetValue¶

BomListDataProvider.UnsetValue¶

Overloaded method UnsetValue

UnsetValue(row, column)
UnsetValue(rows, column)

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

Unsets the data at a particular location in the table.

Signature UnsetValue(row, column)

Parameters:	row (int) – the row to unset column (int) – the column to unset
Returns:	whether or not the data was successfully unset.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Unsets the data on a range of table cells in a specified column. Returns whether any data was successfully unset.

Signature UnsetValue(rows, column)

Parameters:	rows (list of int) – the rows to unset column (int) – the column to be unset
Returns:	whether or not the data was successfully unset.
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

BomListDataProvider Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

ColumnCount¶

RowCount¶

Method Detail¶

Destroy¶

GetBoolean¶

GetDouble¶

GetInteger¶

GetString¶

SetBoolean¶

SetDouble¶

SetInteger¶

SetString¶

UnsetValue¶

NXOpen Python API Reference

Navigation

Related Topics