ToolBuilder Class

class NXOpen.CAM.ToolBuilder

Bases: NXOpen.CAM.NCGroupBuilder

Represents a Tool 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
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
HolderDescription Returns or sets the holder description
HolderLibraryReference Returns or sets the holder libref
LibraryParametersBuilder Returns the Library Data Object
OptimizationMethod Returns or sets the optim method
StartUdeSet Returns the start ude set
Tag Returns the Tag for this object.
TlCtlgNum Returns or sets the Catalog Number
TlDescription Returns or sets the Cutter Description
TlHolderNumberBuilder Returns the Holder Number
TlLibref Returns or sets the Cutter Libref
TlManualToolChange Returns or sets the Manual Tool Change
TlNumberBuilder Returns the Tool Number
TlText Returns or sets the tool text

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.

Property Detail

ChannelName

ToolBuilder.ChannelName

Returns or sets the channel’s name

-------------------------------------

Getter Method

Signature ChannelName

Returns:The channel’s name
Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ChannelName

Parameters:name (str) – the channel’s name

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CutterExportBuilder

ToolBuilder.CutterExportBuilder

Returns the cutter export builder

-------------------------------------

Getter Method

Signature CutterExportBuilder

Returns:
Return type:NXOpen.CAM.CutterExport

New in version NX9.0.1.

License requirements: None.

HolderDescription

ToolBuilder.HolderDescription

Returns or sets the holder description

-------------------------------------

Getter Method

Signature HolderDescription

Returns:the tool holder description value
Return type:str

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature HolderDescription

Parameters:holderDescriptionValue (str) – the tool holder description value

New in version NX7.5.1.

License requirements: cam_base (“CAM BASE”)

HolderLibraryReference

ToolBuilder.HolderLibraryReference

Returns or sets the holder libref

-------------------------------------

Getter Method

Signature HolderLibraryReference

Returns:the tool holder library reference value
Return type:str

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature HolderLibraryReference

Parameters:holderLibrefValue (str) – the tool holder library reference value

New in version NX7.5.1.

License requirements: cam_base (“CAM BASE”)

LibraryParametersBuilder

ToolBuilder.LibraryParametersBuilder

Returns the Library Data Object

-------------------------------------

Getter Method

Signature LibraryParametersBuilder

Returns:
Return type:NXOpen.CAM.Ude

New in version NX9.0.0.

License requirements: None.

TlCtlgNum

ToolBuilder.TlCtlgNum

Returns or sets the Catalog Number

-------------------------------------

Getter Method

Signature TlCtlgNum

Returns:the catalog number value
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TlCtlgNum

Parameters:tlCtlgNumValue (str) – the catalog number value

New in version NX5.0.0.

License requirements: None.

TlDescription

ToolBuilder.TlDescription

Returns or sets the Cutter Description

-------------------------------------

Getter Method

Signature TlDescription

Returns:the cutter description value
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TlDescription

Parameters:tlDescriptionValue (str) – the cutter description value

New in version NX5.0.0.

License requirements: None.

TlHolderNumberBuilder

ToolBuilder.TlHolderNumberBuilder

Returns the Holder Number

-------------------------------------

Getter Method

Signature TlHolderNumberBuilder

Returns:
Return type:NXOpen.CAM.InheritableIntBuilder

New in version NX5.0.0.

License requirements: None.

TlLibref

ToolBuilder.TlLibref

Returns or sets the Cutter Libref

-------------------------------------

Getter Method

Signature TlLibref

Returns:the cutter libref value
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TlLibref

Parameters:tlLibRef (str) – the cutter libref value

New in version NX5.0.0.

License requirements: None.

TlManualToolChange

ToolBuilder.TlManualToolChange

Returns or sets the Manual Tool Change

-------------------------------------

Getter Method

Signature TlManualToolChange

Returns:the manual tool change value
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TlManualToolChange

Parameters:tlManualToolChangeValue (bool) – the manual tool change value

New in version NX5.0.0.

License requirements: None.

TlNumberBuilder

ToolBuilder.TlNumberBuilder

Returns the Tool Number

-------------------------------------

Getter Method

Signature TlNumberBuilder

Returns:
Return type:NXOpen.CAM.InheritableIntBuilder

New in version NX5.0.0.

License requirements: None.

TlText

ToolBuilder.TlText

Returns or sets the tool text

-------------------------------------

Getter Method

Signature TlText

Returns:the tool text value
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TlText

Parameters:tlText (str) – the tool text value

New in version NX5.0.0.

License requirements: None.

Method Detail

GetMaterial

ToolBuilder.GetMaterial

Get tool material

Signature GetMaterial()

Returns:
Return type:str

New in version NX8.0.1.

License requirements: None.

GetMaterialData

ToolBuilder.GetMaterialData

Get material data

Signature GetMaterialData()

Returns:a tuple
Return type:A tuple consisting of (libRef, name, description, code) libRef is a str. name is a str. description is a str. code is a str.

New in version NX8.0.2.

License requirements: None.

SetMaterial

ToolBuilder.SetMaterial

Set tool material

Signature SetMaterial(libRef)

Parameters:libRef (str) –

New in version NX8.0.1.

License requirements: cam_base (“CAM BASE”)

Validate

ToolBuilder.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.