ParamBuilder Class¶
-
class
NXOpen.CAM.ParamBuilder¶ Bases:
NXOpen.BuilderRepresents a manufacturing object builder.
It is the top level builder for all manufacturing objects that have a representation in the Operation Navigator.
This is an abstract class and cannot be instantiated.
New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| OptimizationMethod | Returns or sets the optim method |
| 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. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name |
| GetCustomizableItemNames | Returns the names for all customizable item ids |
| GetObject | Returns the object currently being edited by this builder. |
| 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¶
| ParamBuilderOptimizationTypes Enumeration | Available types for Optimization Method in operation |
Property Detail¶
CycleEvent¶
-
ParamBuilder.CycleEvent¶ Returns the cycle event
-------------------------------------Getter Method
Signature
CycleEventReturns: the cycle event Return type: NXOpen.CAM.UdeNew in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
CycleTable¶
-
ParamBuilder.CycleTable¶ Returns the cycle
-------------------------------------Getter Method
Signature
CycleTableReturns: the cycle table Return type: NXOpen.CAM.CycleNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
OptimizationMethod¶
-
ParamBuilder.OptimizationMethod¶ Returns or sets the optim method
-------------------------------------Getter Method
Signature
OptimizationMethodReturns: the optim method Return type: NXOpen.CAM.ParamBuilderOptimizationTypesNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------Setter Method
Signature
OptimizationMethodParameters: optimMethod ( NXOpen.CAM.ParamBuilderOptimizationTypes) – the optim methodNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
GetCustomizableItemBuilder¶
-
ParamBuilder.GetCustomizableItemBuilder¶ Returns the customizable item builder for the given customizable item name
Signature
GetCustomizableItemBuilder(name)Parameters: name (str) – the ci name Returns: Return type: NXOpen.TaggedObjectNew in version NX11.0.1.
License requirements: None.
GetCustomizableItemNames¶
-
ParamBuilder.GetCustomizableItemNames¶ Returns the names for all customizable item ids
Signature
GetCustomizableItemNames()Returns: the ci names Return type: list of str New in version NX11.0.1.
License requirements: None.
Validate¶
-
ParamBuilder.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.