MachineHeadGroupBuilder Class¶
-
class
NXOpen.CAM.
MachineHeadGroupBuilder
¶ Bases:
NXOpen.CAM.NCGroupBuilder
Represents a MachineHeadGroup Builder
To create a new instance of this class, use
NXOpen.CAM.NCGroupCollection.CreateMachineHeadGroupBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndUdeSet | Returns the end ude set |
IDirectionBuilder | Returns or sets the i direction |
JDirectionBuilder | Returns or sets the j direction |
KDirectionBuilder | Returns or sets the k direction |
OptimizationMethod | Returns or sets the optim method |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
XDistanceBuilder | Returns or sets the x distance |
YDistanceBuilder | Returns or sets the y distance |
ZDistanceBuilder | Returns or sets the z distance |
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. |
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. |
Property Detail¶
IDirectionBuilder¶
-
MachineHeadGroupBuilder.
IDirectionBuilder
¶ Returns or sets the i direction
-------------------------------------
Getter Method
Signature
IDirectionBuilder()
Returns: the i direction value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
IDirectionBuilder(iValue)
Parameters: iValue (float) – the i direction value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
JDirectionBuilder¶
-
MachineHeadGroupBuilder.
JDirectionBuilder
¶ Returns or sets the j direction
-------------------------------------
Getter Method
Signature
JDirectionBuilder()
Returns: the j direction value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
JDirectionBuilder(jValue)
Parameters: jValue (float) – the j direction value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
KDirectionBuilder¶
-
MachineHeadGroupBuilder.
KDirectionBuilder
¶ Returns or sets the k direction
-------------------------------------
Getter Method
Signature
KDirectionBuilder()
Returns: the k direction value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
KDirectionBuilder(kValue)
Parameters: kValue (float) – the k direction value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
XDistanceBuilder¶
-
MachineHeadGroupBuilder.
XDistanceBuilder
¶ Returns or sets the x distance
-------------------------------------
Getter Method
Signature
XDistanceBuilder()
Returns: the x distance value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
XDistanceBuilder(xValue)
Parameters: xValue (float) – the x distance value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
YDistanceBuilder¶
-
MachineHeadGroupBuilder.
YDistanceBuilder
¶ Returns or sets the y distance
-------------------------------------
Getter Method
Signature
YDistanceBuilder()
Returns: the y distance value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
YDistanceBuilder(yValue)
Parameters: yValue (float) – the y distance value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ZDistanceBuilder¶
-
MachineHeadGroupBuilder.
ZDistanceBuilder
¶ Returns or sets the z distance
-------------------------------------
Getter Method
Signature
ZDistanceBuilder()
Returns: the z distance value Return type: float New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
ZDistanceBuilder(zValue)
Parameters: zValue (float) – the z distance value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
MachineHeadGroupBuilder.
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.