StockPerPassBuilder Class¶
-
class
NXOpen.CAM.
StockPerPassBuilder
¶ Bases:
NXOpen.Builder
Represents a Builder which holds the data for a set of individual stock per pass.
This is an abstract class and cannot be instantiated.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Tag | Returns the Tag for this object. |
ToolDiameter | Returns or sets the Tool Diameter. |
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. |
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. |
GetStockOfPass | Get stock of the specific pass @return the stock of the pass |
Modify | Modify item |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateList | Update list dependent on rough and finish passes number. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ToolDiameter¶
-
StockPerPassBuilder.
ToolDiameter
¶ Returns or sets the Tool Diameter.
It is used to validate data of list items and should be consistant with tool diameter of main object. i.e wedm operation. So when tool diameter of main object is changed, it should be updated immediately.
-------------------------------------
Getter Method
Signature
ToolDiameter()
Returns: the tool diameter Return type: float New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
ToolDiameter(diameter)
Parameters: diameter (float) – the tool diameter New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
GetStockOfPass¶
-
StockPerPassBuilder.
GetStockOfPass
¶ Get stock of the specific pass
Signature
GetStockOfPass(passIndex)
Parameters: passIndex (int) – Returns: the stock of the pass Return type: float New in version NX7.5.3.
License requirements: cam_base (“CAM BASE”)
Modify¶
-
StockPerPassBuilder.
Modify
¶ Modify item
Signature
Modify(pass, stock)
Parameters: - pass (int) – the pass on which stock will be modified
- stock (float) – the new value of stock
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
UpdateList¶
-
StockPerPassBuilder.
UpdateList
¶ Update list dependent on rough and finish passes number.
Total pass number will be equal to (rough passes + finish passes -1), so this function should be invoked as rough/finish passes changing
Signature
UpdateList(roughPass, finishPass)
Parameters: - roughPass (int) – the rough passes
- finishPass (int) – the finish passes
New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
StockPerPassBuilder.
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.