TurnToolBuilder Class

class NXOpen.CAM.TurnToolBuilder

Bases: NXOpen.CAM.TurningToolBuilder

Represents a Turn tool builder

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

New in version NX5.0.0.

Properties

Property	Description
ButtonDiameterBuilder	Returns the button diameter builder (inheritable double)
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
HolderAngleBuilder	Returns the holder angle builder (inheritable double)
HolderControlAngleBuilder	Returns the holder control angle (inheritable double)
HolderControlWidthBuilder	Returns the holder control width (inheritable double)
HolderDescription	Returns or sets the holder description
HolderHand	Returns or sets the turn holder hand
HolderLengthBuilder	Returns the turn holder length builder (inheritable double)
HolderLibraryReference	Returns or sets the holder libref
HolderLock	Returns or sets the lock turn holder toggle
HolderShankDefinitionMode	Returns or sets the holder shank definition mode
HolderShankLineBuilder	Returns the turn holder shank line builder (inheritable double)
HolderShankType	Returns or sets the turn holder shank type
HolderShankWidthBuilder	Returns the turn holder shank width builder (inheritable double)
HolderStyle	Returns or sets the turn holder style
HolderUse	Returns or sets the use turn holder toggle
HolderWidthBuilder	Returns the turn holder width builder (inheritable double)
InsertLengthBuilder	Returns the insert length builder (inheritable double)
InsertPosition	Returns or sets the insert position
InsertShape	Returns or sets the insert shape
InsertWidthBuilder	Returns the insert width builder (inheritable double)
LeftAngleBuilder	Returns the left angle builder (inheritable double)
LibraryParametersBuilder	Returns the Library Data Object
ManageToolPartBuilder	Returns the manage tool part builder
MaxDepthBuilder	Returns the max.
MaxDepthToggle	Returns or sets the max.
MaxFacingDiameterBuilder	Returns the max.
MaxFacingDiameterToggle	Returns or sets the max.
MaxToolReachBuilder	Returns the max.
MaxToolReachToggle	Returns or sets the max.
McsSpindleGroup	Returns or sets the MCS spindle group
MinBoringDiameterBuilder	Returns the min.
MinBoringDiameterToggle	Returns or sets the min.
MinFacingDiameterBuilder	Returns the min.
MinFacingDiameterToggle	Returns or sets the min.
NoseAngleBuilder	Returns the nose angle builder (inheritable double)
NoseRadiusBuilder	Returns the nose radius builder (inheritable double)
NoseWidthBuilder	Returns the nose width builder (inheritable double)
OptimizationMethod	Returns or sets the optim method
OrientAngleBuilder	Returns the orient angle builder (inheritable double)
ReliefAngleBuilder	Returns the relief angle (inheritable double)
ReliefAngleType	Returns or sets the relief angle type
RightAngleBuilder	Returns the right angle builder (inheritable double)
SizeBuilder	Returns the size builder (inheritable double)
SizeOption	Returns or sets the size option
StartUdeSet	Returns the start ude set
Tag	Returns the Tag for this object.
ThicknessBuilder	Returns the thickness builder (inheritable double)
ThicknessType	Returns or sets the thickness type
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
TrackingBuilder	Returns the tracking point builder
XMountBuilder	Returns the x mount builder (inheritable double)
YMountBuilder	Returns the y mount builder (inheritable double)

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

TurnToolBuilderHolderHands Enumeration	the available turn holder hand options
TurnToolBuilderHolderShankDefinitionModes Enumeration	the available turn holder shank definition modes
TurnToolBuilderHolderStyles Enumeration	the available turn holder style options
TurnToolBuilderInsertShapes Enumeration	the available insert shapes
TurnToolBuilderReliefAngleTypes Enumeration	the available relief angle types
TurnToolBuilderSizeOptions Enumeration	the available size options
TurnToolBuilderThicknessTypes Enumeration	the available thickness types

Property Detail

ButtonDiameterBuilder

TurnToolBuilder.ButtonDiameterBuilder

Returns the button diameter builder (inheritable double)

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

Getter Method

Signature ButtonDiameterBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

HolderControlAngleBuilder

TurnToolBuilder.HolderControlAngleBuilder

Returns the holder control angle (inheritable double)

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

Getter Method

Signature HolderControlAngleBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

HolderControlWidthBuilder

TurnToolBuilder.HolderControlWidthBuilder

Returns the holder control width (inheritable double)

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

Getter Method

Signature HolderControlWidthBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

HolderHand

TurnToolBuilder.HolderHand

Returns or sets the turn holder hand

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

Getter Method

Signature HolderHand

Returns: Return type:NXOpen.CAM.TurnToolBuilderHolderHands

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature HolderHand

Parameters:holderHand (NXOpen.CAM.TurnToolBuilderHolderHands) –

New in version NX5.0.0.

License requirements: None.

HolderShankDefinitionMode

TurnToolBuilder.HolderShankDefinitionMode

Returns or sets the holder shank definition mode

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

Getter Method

Signature HolderShankDefinitionMode

Returns: Return type:NXOpen.CAM.TurnToolBuilderHolderShankDefinitionModes

New in version NX11.0.2.

License requirements: None.

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

Setter Method

Signature HolderShankDefinitionMode

Parameters:holderShankDefinitionMode (NXOpen.CAM.TurnToolBuilderHolderShankDefinitionModes) –

New in version NX11.0.2.

License requirements: None.

HolderStyle

TurnToolBuilder.HolderStyle

Returns or sets the turn holder style

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

Getter Method

Signature HolderStyle

Returns: Return type:NXOpen.CAM.TurnToolBuilderHolderStyles

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature HolderStyle

Parameters:holderStyle (NXOpen.CAM.TurnToolBuilderHolderStyles) –

New in version NX5.0.0.

License requirements: None.

InsertShape

TurnToolBuilder.InsertShape

Returns or sets the insert shape

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

Getter Method

Signature InsertShape

Returns: Return type:NXOpen.CAM.TurnToolBuilderInsertShapes

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature InsertShape

Parameters:insertShape (NXOpen.CAM.TurnToolBuilderInsertShapes) –

New in version NX5.0.0.

License requirements: None.

NoseAngleBuilder

TurnToolBuilder.NoseAngleBuilder

Returns the nose angle builder (inheritable double)

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

Getter Method

Signature NoseAngleBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ReliefAngleBuilder

TurnToolBuilder.ReliefAngleBuilder

Returns the relief angle (inheritable double)

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

Getter Method

Signature ReliefAngleBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ReliefAngleType

TurnToolBuilder.ReliefAngleType

Returns or sets the relief angle type

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

Getter Method

Signature ReliefAngleType

Returns: Return type:NXOpen.CAM.TurnToolBuilderReliefAngleTypes

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ReliefAngleType

Parameters:reliefAngleType (NXOpen.CAM.TurnToolBuilderReliefAngleTypes) –

New in version NX5.0.0.

License requirements: None.

SizeBuilder

TurnToolBuilder.SizeBuilder

Returns the size builder (inheritable double)

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

Getter Method

Signature SizeBuilder

Returns: Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SizeOption

TurnToolBuilder.SizeOption

Returns or sets the size option

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

Getter Method

Signature SizeOption

Returns: Return type:NXOpen.CAM.TurnToolBuilderSizeOptions

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature SizeOption

Parameters:sizeOption (NXOpen.CAM.TurnToolBuilderSizeOptions) –

New in version NX5.0.0.

License requirements: None.

ThicknessType

TurnToolBuilder.ThicknessType

Returns or sets the thickness type

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

Getter Method

Signature ThicknessType

Returns: Return type:NXOpen.CAM.TurnToolBuilderThicknessTypes

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ThicknessType

Parameters:thicknessType (NXOpen.CAM.TurnToolBuilderThicknessTypes) –

New in version NX5.0.0.

License requirements: None.

Method Detail

Validate

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