MultipleStepoverBuilder Class¶
-
class
NXOpen.CAM.MultipleStepoverBuilder¶ Bases:
NXOpen.BuilderRepresents a Builder which holds the data for a set of individual number of passes and stepover distance.
This is an abstract class and cannot be instantiated.
New in version NX6.0.0.
Methods¶
| Method | Description |
|---|---|
| Add | Add a new item |
| Commit | Commits any edits that have been applied to the builder. |
| Delete | Delete a item |
| 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. |
| GetData | Get item for the specified stepover index |
| GetNumberOfStepovers | Get number of stepovers |
| GetObject | Returns the object currently being edited by this builder. |
| Modify | Modify item |
| MoveDown | Move down a item |
| MoveUp | Move up a item |
| 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. |
Method Detail¶
Add¶
-
MultipleStepoverBuilder.Add¶ Add a new item
Signature
Add(indexAfter, numOfPasses, distance, intent)Parameters: - indexAfter (int) – the index which new item will be added after
- numOfPasses (int) – the num of passes for new item
- distance (float) – the distance for new item
- intent (int) – the intent for new item
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
Delete¶
-
MultipleStepoverBuilder.Delete¶ Delete a item
Signature
Delete(index)Parameters: index (int) – the index of item to be deleted New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
GetData¶
-
MultipleStepoverBuilder.GetData¶ Get item for the specified stepover index
Signature
GetData(index)Parameters: index (int) – the index of item to be modified Returns: a tuple Return type: A tuple consisting of (numOfPasses, distance, intent) numOfPasses is a int. the new value of num of passes distance is a float. the new value of distance intent is a int. the new value of intent New in version NX7.5.3.
License requirements: cam_base (“CAM BASE”)
GetNumberOfStepovers¶
-
MultipleStepoverBuilder.GetNumberOfStepovers¶ Get number of stepovers
Signature
GetNumberOfStepovers()Returns: the number of stepover Return type: int New in version NX7.5.3.
License requirements: cam_base (“CAM BASE”)
Modify¶
-
MultipleStepoverBuilder.Modify¶ Modify item
Signature
Modify(index, numOfPasses, distance, intent)Parameters: - index (int) – the index of item to be modified
- numOfPasses (int) – the new value of num of passes
- distance (float) – the new value of distance
- intent (int) – the new value of intent
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MoveDown¶
-
MultipleStepoverBuilder.MoveDown¶ Move down a item
Signature
MoveDown(index)Parameters: index (int) – the index of item to be moved down New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MoveUp¶
-
MultipleStepoverBuilder.MoveUp¶ Move up a item
Signature
MoveUp(index)Parameters: index (int) – the index of item to be moved up New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
MultipleStepoverBuilder.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.