BomListBuilder Class¶
-
class
NXOpen.Tooling.BomListBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Tooling.BomListBuilderbuilder.To create a new instance of this class, use
NXOpen.Tooling.MoldwizardManager.CreateBomListBuilderDefault values.
Property Value BomListType BomList New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| 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 |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetAttributeStrings | Gets all the attributes listed in the current template @return Attribute strings. |
| GetColumn | Gets column number of given attribute |
| 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 part occs of given row @return The part occs of given row |
| GetRows | Gets all the row numbers in the given List @return All row numbers in the given list |
| IgnoreComponents | Ignores components of given row in the Hide List so that the row can not be exported to excel. |
| ModifyBomData | Modifies BOM data |
| PopulateBomListData | Populates BOM list data according to current template |
| ShowComponents | Shows components of given row in the BOM list so that the row can be exported to excel. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| BomListBuilderBomListTypes Enumeration | Represents an index to components list type. |
Property Detail¶
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.BomListBuilderBomListTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BomListType(bomListType)Parameters: bomListType ( NXOpen.Tooling.BomListBuilderBomListTypes) –New in version NX10.0.0.
License requirements: None.
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(bomTemplate)Parameters: bomTemplate (str) – New in version NX10.0.0.
License requirements: None.
SelectComponents¶
-
BomListBuilder.SelectComponents¶ Returns the select component needed to get stocksize
-------------------------------------Getter Method
Signature
SelectComponents()Returns: Return type: NXOpen.Assemblies.SelectComponentListNew in version NX10.0.0.
License requirements: None.
Method Detail¶
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.
License requirements: None.
GetColumn¶
-
BomListBuilder.GetColumn¶ Gets column number of given attribute
Signature
GetColumn(attrString)Parameters: attrString (str) – NOTE: The full Unicode character set is not supported for this parameter. New in version NX10.0.0.
License requirements: None.
GetPartOccs¶
-
BomListBuilder.GetPartOccs¶ Gets part occs of given row
Signature
GetPartOccs(rowNumber)Parameters: rowNumber (int) – Returns: The part occs of given row Return type: list of NXOpen.Assemblies.ComponentNew 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.
License requirements: None.
IgnoreComponents¶
-
BomListBuilder.IgnoreComponents¶ Ignores components of given row in the Hide List so that the row can not be exported to excel.
Signature
IgnoreComponents(rowNumber, partOccs)Parameters: - rowNumber (int) –
- partOccs (list of
NXOpen.Assemblies.Component) –
New in version NX10.0.0.
License requirements: None.
ModifyBomData¶
-
BomListBuilder.ModifyBomData¶ Modifies BOM data
Signature
ModifyBomData(rowNumber, columnNumber, userString)Parameters: - rowNumber (int) –
- columnNumber (int) –
- userString (str) – NOTE: The full Unicode character set is not supported for this parameter.
New in version NX10.0.0.
License requirements: None.
PopulateBomListData¶
-
BomListBuilder.PopulateBomListData¶ Populates BOM list data according to current template
Signature
PopulateBomListData()New in version NX10.0.0.
License requirements: None.
ShowComponents¶
-
BomListBuilder.ShowComponents¶ Shows components of given row in the BOM list so that the row can be exported to excel.
Signature
ShowComponents(rowNumber, partOccs)Parameters: - rowNumber (int) –
- partOccs (list of
NXOpen.Assemblies.Component) –
New in version NX10.0.0.
License requirements: None.
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.