WireTool Class

class NXOpen.CAM.WireTool

Bases: NXOpen.CAM.ToolBuilder

Represents a Wire Tool

To create a new instance of this class, use NXOpen.CAM.NCGroupCollection.CreateWireTool()

New in version NX9.0.0.

Properties

Property Description
AdjReg Returns the Adjust Register
ChannelName Returns or sets the channel’s name
CutcomReg Returns the Cutcom Register
CutterExportBuilder Returns the cutter export builder
CycleEvent Returns the cycle event
CycleTable Returns the cycle
Description Returns or sets the description
Diameter Returns the Tool Diameter (inheritable double)
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
WireGuideList Returns the wire guide list

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreateWireGuide Create a wire guide
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

AdjReg

WireTool.AdjReg

Returns the Adjust Register

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

Getter Method

Signature AdjReg

Returns:
Return type:NXOpen.CAM.InheritableIntBuilder

New in version NX9.0.0.

License requirements: None.

CutcomReg

WireTool.CutcomReg

Returns the Cutcom Register

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

Getter Method

Signature CutcomReg

Returns:the tool cutcom register value
Return type:NXOpen.CAM.InheritableIntBuilder

New in version NX9.0.0.

License requirements: None.

Diameter

WireTool.Diameter

Returns the Tool Diameter (inheritable double)

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

Getter Method

Signature Diameter

Returns:
Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

WireGuideList

WireTool.WireGuideList

Returns the wire guide list

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

Getter Method

Signature WireGuideList

Returns:
Return type:NXOpen.CAM.WireGuideList

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

CreateWireGuide

WireTool.CreateWireGuide

Create a wire guide

Signature CreateWireGuide()

Returns:the wire guide object
Return type:NXOpen.CAM.WireGuide

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

Validate

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