MillingToolBuilder Class¶
-
class
NXOpen.CAM.
MillingToolBuilder
¶ Bases:
NXOpen.CAM.ToolBuilder
Represents a MillingTool Builder
This is an abstract class, and cannot be instantiated.
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ChannelName | Returns or sets the channel’s name |
CoolantThrough | Returns or sets the coolant through parameter |
CutterExportBuilder | Returns the cutter export builder |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndUdeSet | Returns the end ude set |
HelicalDiameter | Returns the helical diameter |
HelicalRampAngle | Returns the ramp angle |
HolderDescription | Returns or sets the holder description |
HolderLibraryReference | Returns or sets the holder libref |
HolderSectionBuilder | Returns the holder sections builder |
LibraryParametersBuilder | Returns the Library Data Object |
MaxCutWidth | Returns the max cut width |
MillingTrackpointBuilder | Returns the mill trackpoint builder |
MinRampLength | Returns the min ramp length |
OptimizationMethod | Returns or sets the optim method |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
TaperedShankDiameterBuilder | Returns the tapered shank diameter |
TaperedShankLengthBuilder | Returns the tapered shank length |
TaperedShankTaperLengthBuilder | Returns the tapered shank taper length |
TlAdjRegBuilder | Returns the Adjust Register |
TlCtlgNum | Returns or sets the Catalog Number |
TlCutcomReg | Returns or sets the Cutcom Register |
TlCutcomRegBuilder | Returns the Cutcom Register Builder |
TlDescription | Returns or sets the Cutter Description |
TlDiameterBuilder | Returns the Tool Diameter builder (inheritable double) |
TlDirection | Returns or sets the tool direction |
TlFluteLnBuilder | Returns the flute length |
TlHeightBuilder | Returns the length |
TlHolderDescription | Returns or sets the Holder Description |
TlHolderLibref | Returns or sets the Holder Library Reference |
TlHolderNumberBuilder | Returns the Holder Number |
TlLibref | Returns or sets the Cutter Libref |
TlLowCorRadBuilder | Returns the low corner radius |
TlManualToolChange | Returns or sets the Manual Tool Change |
TlNumFlutesBuilder | Returns the Number of Flutes builder (inheritable integer) |
TlNumberBuilder | Returns the Tool Number |
TlShankDiaBuilder | Returns the Shank Diameter builder (inheritable double) |
TlTaperAngBuilder | Returns the Taper Angle builder (inheritable double) |
TlText | Returns or sets the tool text |
TlUpCorRadBuilder | Returns the up corner radius |
TlZMountBuilder | Returns the Z Mount builder (inheritable double) |
TlZOffsetBuilder | Returns the Z Offset builder (inheritable double) |
UseTaperedShank | Returns or sets the use tapered shank |
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 |
GetMaterial | Get tool material |
GetMaterialData | Get material data |
GetObject | Returns the object currently being edited by this builder. |
SetMaterial | Set tool material |
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¶
MillingToolBuilderToolDirectionTypes Enumeration | Available types for tool direction milling tool |
Property Detail¶
CoolantThrough¶
-
MillingToolBuilder.
CoolantThrough
¶ Returns or sets the coolant through parameter
-------------------------------------
Getter Method
Signature
CoolantThrough
Returns: the coolant through Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoolantThrough
Parameters: coolantThrough (bool) – the coolant through New in version NX7.5.0.
License requirements: None.
HelicalDiameter¶
-
MillingToolBuilder.
HelicalDiameter
¶ Returns the helical diameter
-------------------------------------
Getter Method
Signature
HelicalDiameter
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX8.0.0.
License requirements: None.
HelicalRampAngle¶
-
MillingToolBuilder.
HelicalRampAngle
¶ Returns the ramp angle
-------------------------------------
Getter Method
Signature
HelicalRampAngle
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX8.0.0.
License requirements: None.
HolderSectionBuilder¶
-
MillingToolBuilder.
HolderSectionBuilder
¶ Returns the holder sections builder
-------------------------------------
Getter Method
Signature
HolderSectionBuilder
Returns: Return type: NXOpen.CAM.HolderSectionBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MaxCutWidth¶
-
MillingToolBuilder.
MaxCutWidth
¶ Returns the max cut width
-------------------------------------
Getter Method
Signature
MaxCutWidth
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX8.0.0.
License requirements: None.
MillingTrackpointBuilder¶
-
MillingToolBuilder.
MillingTrackpointBuilder
¶ Returns the mill trackpoint builder
-------------------------------------
Getter Method
Signature
MillingTrackpointBuilder
Returns: Return type: NXOpen.CAM.MillingTrackpointBuilder
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MinRampLength¶
-
MillingToolBuilder.
MinRampLength
¶ Returns the min ramp length
-------------------------------------
Getter Method
Signature
MinRampLength
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX8.0.0.
License requirements: None.
TaperedShankDiameterBuilder¶
-
MillingToolBuilder.
TaperedShankDiameterBuilder
¶ Returns the tapered shank diameter
-------------------------------------
Getter Method
Signature
TaperedShankDiameterBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX8.0.0.
License requirements: None.
TaperedShankLengthBuilder¶
-
MillingToolBuilder.
TaperedShankLengthBuilder
¶ Returns the tapered shank length
-------------------------------------
Getter Method
Signature
TaperedShankLengthBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX8.0.0.
License requirements: None.
TaperedShankTaperLengthBuilder¶
-
MillingToolBuilder.
TaperedShankTaperLengthBuilder
¶ Returns the tapered shank taper length
-------------------------------------
Getter Method
Signature
TaperedShankTaperLengthBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX8.0.0.
License requirements: None.
TlAdjRegBuilder¶
-
MillingToolBuilder.
TlAdjRegBuilder
¶ Returns the Adjust Register
-------------------------------------
Getter Method
Signature
TlAdjRegBuilder
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX5.0.0.
License requirements: None.
TlCutcomReg¶
-
MillingToolBuilder.
TlCutcomReg
¶ Returns or sets the Cutcom Register
-------------------------------------
Getter Method
Signature
TlCutcomReg
Returns: the tool cutcom register value Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TlCutcomReg
Parameters: tlCutcomRegValue (int) – the tool cutcom register value New in version NX5.0.0.
License requirements: None.
TlCutcomRegBuilder¶
-
MillingToolBuilder.
TlCutcomRegBuilder
¶ Returns the Cutcom Register Builder
-------------------------------------
Getter Method
Signature
TlCutcomRegBuilder
Returns: the tool cutcom register value Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX6.0.0.
License requirements: None.
TlDiameterBuilder¶
-
MillingToolBuilder.
TlDiameterBuilder
¶ Returns the Tool Diameter builder (inheritable double)
-------------------------------------
Getter Method
Signature
TlDiameterBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlDirection¶
-
MillingToolBuilder.
TlDirection
¶ Returns or sets the tool direction
-------------------------------------
Getter Method
Signature
TlDirection
Returns: Return type: NXOpen.CAM.MillingToolBuilderToolDirectionTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TlDirection
Parameters: tlDirection ( NXOpen.CAM.MillingToolBuilderToolDirectionTypes
) –New in version NX5.0.0.
License requirements: None.
TlFluteLnBuilder¶
-
MillingToolBuilder.
TlFluteLnBuilder
¶ Returns the flute length
-------------------------------------
Getter Method
Signature
TlFluteLnBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlHeightBuilder¶
-
MillingToolBuilder.
TlHeightBuilder
¶ Returns the length
-------------------------------------
Getter Method
Signature
TlHeightBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlHolderDescription¶
-
MillingToolBuilder.
TlHolderDescription
¶ Returns or sets the Holder Description
-------------------------------------
Getter Method
Signature
TlHolderDescription
Returns: the tool holder description value Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TlHolderDescription
Parameters: tlHolderDescriptionValue (str) – the tool holder description value New in version NX5.0.0.
License requirements: None.
TlHolderLibref¶
-
MillingToolBuilder.
TlHolderLibref
¶ Returns or sets the Holder Library Reference
-------------------------------------
Getter Method
Signature
TlHolderLibref
Returns: the holder Library Reference value Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TlHolderLibref
Parameters: tlHolderLibrefValue (str) – the holder Library Reference value New in version NX5.0.0.
License requirements: None.
TlLowCorRadBuilder¶
-
MillingToolBuilder.
TlLowCorRadBuilder
¶ Returns the low corner radius
-------------------------------------
Getter Method
Signature
TlLowCorRadBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlNumFlutesBuilder¶
-
MillingToolBuilder.
TlNumFlutesBuilder
¶ Returns the Number of Flutes builder (inheritable integer)
-------------------------------------
Getter Method
Signature
TlNumFlutesBuilder
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlShankDiaBuilder¶
-
MillingToolBuilder.
TlShankDiaBuilder
¶ Returns the Shank Diameter builder (inheritable double)
-------------------------------------
Getter Method
Signature
TlShankDiaBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlTaperAngBuilder¶
-
MillingToolBuilder.
TlTaperAngBuilder
¶ Returns the Taper Angle builder (inheritable double)
-------------------------------------
Getter Method
Signature
TlTaperAngBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlUpCorRadBuilder¶
-
MillingToolBuilder.
TlUpCorRadBuilder
¶ Returns the up corner radius
-------------------------------------
Getter Method
Signature
TlUpCorRadBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlZMountBuilder¶
-
MillingToolBuilder.
TlZMountBuilder
¶ Returns the Z Mount builder (inheritable double)
-------------------------------------
Getter Method
Signature
TlZMountBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TlZOffsetBuilder¶
-
MillingToolBuilder.
TlZOffsetBuilder
¶ Returns the Z Offset builder (inheritable double)
-------------------------------------
Getter Method
Signature
TlZOffsetBuilder
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
UseTaperedShank¶
-
MillingToolBuilder.
UseTaperedShank
¶ Returns or sets the use tapered shank
-------------------------------------
Getter Method
Signature
UseTaperedShank
Returns: tapered shank used Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseTaperedShank
Parameters: useTaperedShank (bool) – use tapered shank New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
MillingToolBuilder.
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.