CenterlineDrillTurningBuilder Class¶

class NXOpen.CAM.CenterlineDrillTurningBuilder¶

Bases: NXOpen.CAM.TurningOperationBuilder

Represents a CenterlineDrillTurningBuilder

To create a new instance of this class, use NXOpen.CAM.OperationCollection.CreateCenterlineDrillTurningBuilder()

New in version NX6.0.0.

Properties¶

Property	Description
AdditionalCommands	Returns or sets the Additional Commands
BreakThrough	Returns or sets the break through toggle IMPORTANT: Parameter is obsolete from NX9 on and must not be used longer.
BreakThroughDistance	Returns the break through distance IMPORTANT: Parameter is obsolete from NX9 on and must not be used longer.
CenterlineCycle	Returns or sets the centerline cycle
ChannelName	Returns or sets the channel’s name
ChipRemovalIncrementType	Returns or sets the chip removal increment type
ClearanceDistance	Returns the clearance distance
ConstantIncrement	Returns the constant increment
CrossHoleAngle	Returns the cross hole angle
CrossHoleCircle	Returns or sets the cross hole circle
CrossHoleDiameter	Returns the cross hole diameter
CrossHoleDistance	Returns the cross hole distance
CycleEvent	Returns the cycle event
CycleTable	Returns the cycle
DepthDistance	Returns the depth distance
DepthEndPoint	Returns or sets the depth end point
DepthOffset	Returns the depth offset value
DepthOption	Returns or sets the depth option
DepthReference	Returns or sets the depth reference
Description	Returns or sets the description
DrillStep	Returns the drill step
DrillStepModifier1	Returns the drill step modifier1
DrillStepModifier2	Returns the drill step modifier2
DrillingLocation	Returns or sets the drilling location
DwellType	Returns or sets the dwell type
DwellValue	Returns the dwell value
EndOfPath	Returns the end event builder
EndUdeSet	Returns the end ude set
EngageDistance	Returns the engage distance
EntranceDiameter	Returns the entrance diameter
FeedsBuilder	Returns the feeds and speeds builder
FinalRetractDistance	Returns the retract distance for simulated cycles
FinalRetractType	Returns or sets the retract type for simulated cycles
FlipToolAroundHolder	Returns or sets the Flip Tool Around Holder toggle
Geometry	Returns the geometry builder
GougeChecking	Returns or sets the gouge checking flag
HoleAxisType	Returns or sets the Hole Axis Type
HoleDepth	Returns the max depth distance builder
HoleDepthType	Returns or sets the Hole Depth Type
LayoutAndLayer	Returns the Layer and Layout
MachineCycleSubroutineName	Returns or sets the machine cycle subroutine name
MotionOutput	Returns or sets the motion output
MotionOutputBuilder	Returns the motion output builder
NonCuttingBuilder	Returns the non-cutting builder
Notes	Returns the notes builder
OffCenterDistance	Returns the off center distance
OptimizationBasedOn	Returns or sets the optimization based on in operation
OptimizationDistanceMethod	Returns or sets the optimization distance method in operation
OptimizationLevel	Returns or sets the optimization level in operation
OptimizationMethod	Returns or sets the optim method
OutputOption	Returns or sets the output option
PathDisplayOptions	Returns the path display options builder
PostToolPathExit	Returns or sets the environment variable that points to the post tool path generation library which has the exit
ReorientToolHolder	Returns or sets the Reorient Tool Holder toggle.
ReorientToolHolderMode	Returns or sets the Reorient Tool Holder Mode
RepositionDistance	Returns the reposition distance
RetractDistance	Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange	Returns the Retract Distance on Tool Axis Change builder (inheritable double)
ReverseDirection	Returns or sets the reverse direction value
RotateTrackingPoint	Returns or sets the Rotate Tracking Point toggle
SafeClearance	Returns the safe clearance builder
SafeOrDepartureDistance	Returns the safe or departure distance
SelectToolFlag	Returns or sets the user selected tool
SpindleStop	Returns or sets the spindle stop
StartOfPath	Returns the start event builder
StartPosition	Returns or sets the start position
StartPositionPoint	Returns or sets the start position point
StartUdeSet	Returns the start ude set
Tag	Returns the Tag for this object.
ToolChangeSetting	Returns the tool change builder
ToolHolderAngle	Returns the Tool Holder Angle
ToolPathEditor	Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder	Returns the tool path split Parameters
TrackingPointStatus	Returns or sets the tracking point status
UpdateIpw	Returns or sets the update IPW mode
UseMachineCycle	Returns or sets the Use Machine Cycle toggle
VariableIncrementList	Returns the variable increment list

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
GetCycleTrackingPoint	Returns the cycle tracking point
GetHoleAxisValues	Get the Hole Axis values
GetObject	Returns the object currently being edited by this builder.
SetCycleTrackingPoint	Sets the cycle tracking point
SetHoleAxisValues	Set the Hole Axis values
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¶

CenterlineDrillTurningBuilderCycleTypes Enumeration	the centerline cycle types
CenterlineDrillTurningBuilderDepthReferenceTypes Enumeration	the depth reference option types
CenterlineDrillTurningBuilderDepthTypes Enumeration	the depth option types
CenterlineDrillTurningBuilderDrillingLocationTypes Enumeration	the drilling location
CenterlineDrillTurningBuilderDwellTypes Enumeration	the dwell modes
CenterlineDrillTurningBuilderFinalRetractTypes Enumeration	the retract types for simulated cycles
CenterlineDrillTurningBuilderOutputOptionTypes Enumeration	the output option
CenterlineDrillTurningBuilderRemovalIncrementTypes Enumeration	the removal increment types
CenterlineDrillTurningBuilderSpindleStopTypes Enumeration	the spindle stop types
CenterlineDrillTurningBuilderStartPositionTypes Enumeration	the start position

Property Detail¶

BreakThrough¶

CenterlineDrillTurningBuilder.BreakThrough¶

Returns or sets the break through toggle IMPORTANT: Parameter is obsolete from NX9 on and must not be used longer.

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

Getter Method

Signature BreakThrough

Returns:	the break through flag value
Return type:	bool

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use ‘depth reference’ instead.

License requirements: None.

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

Setter Method

Signature BreakThrough

Parameters:	breakThroughFlag (bool) – the break through flag value

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use ‘depth reference’ instead.

License requirements: cam_base (“CAM BASE”)

BreakThroughDistance¶

CenterlineDrillTurningBuilder.BreakThroughDistance¶

Returns the break through distance IMPORTANT: Parameter is obsolete from NX9 on and must not be used longer.

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

Getter Method

Signature BreakThroughDistance

Returns:	the break through distance
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use ‘depth offset’ instead.

License requirements: None.

CenterlineCycle¶

CenterlineDrillTurningBuilder.CenterlineCycle¶

Returns or sets the centerline cycle

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

Getter Method

Signature CenterlineCycle

Returns:	the cycle
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderCycleTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CenterlineCycle

Parameters:	cycleMode (`NXOpen.CAM.CenterlineDrillTurningBuilderCycleTypes`) – the cycle

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ChipRemovalIncrementType¶

CenterlineDrillTurningBuilder.ChipRemovalIncrementType¶

Returns or sets the chip removal increment type

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

Getter Method

Signature ChipRemovalIncrementType

Returns:	the chip removal increment type
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderRemovalIncrementTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ChipRemovalIncrementType

Parameters:	incrementType (`NXOpen.CAM.CenterlineDrillTurningBuilderRemovalIncrementTypes`) – the removal increment type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ClearanceDistance¶

CenterlineDrillTurningBuilder.ClearanceDistance¶

Returns the clearance distance

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

Getter Method

Signature ClearanceDistance

Returns:	the clearance distance builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

ConstantIncrement¶

CenterlineDrillTurningBuilder.ConstantIncrement¶

Returns the constant increment

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

Getter Method

Signature ConstantIncrement

Returns:	the constant increment
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

CrossHoleAngle¶

CenterlineDrillTurningBuilder.CrossHoleAngle¶

Returns the cross hole angle

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

Getter Method

Signature CrossHoleAngle

Returns:	the cross hole angle builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

CrossHoleCircle¶

CenterlineDrillTurningBuilder.CrossHoleCircle¶

Returns or sets the cross hole circle

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

Getter Method

Signature CrossHoleCircle

Returns:	the cross hole circle
Return type:	`NXOpen.NXObject`

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CrossHoleCircle

Parameters:	crossHoleCircle (`NXOpen.NXObject`) – the cross hole circle

New in version NX7.0.0.

License requirements: cam_base (“CAM BASE”)

CrossHoleDiameter¶

CenterlineDrillTurningBuilder.CrossHoleDiameter¶

Returns the cross hole diameter

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

Getter Method

Signature CrossHoleDiameter

Returns:	the cross hole diameter
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

CrossHoleDistance¶

CenterlineDrillTurningBuilder.CrossHoleDistance¶

Returns the cross hole distance

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

Getter Method

Signature CrossHoleDistance

Returns:	the cross hole distance
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

DepthDistance¶

CenterlineDrillTurningBuilder.DepthDistance¶

Returns the depth distance

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

Getter Method

Signature DepthDistance

Returns:	the off center distance builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

DepthEndPoint¶

CenterlineDrillTurningBuilder.DepthEndPoint¶

Returns or sets the depth end point

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

Getter Method

Signature DepthEndPoint

Returns:	the depth end point
Return type:	`NXOpen.Point`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DepthEndPoint

Parameters:	endPoint (`NXOpen.Point`) – the depth end point

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DepthOffset¶

CenterlineDrillTurningBuilder.DepthOffset¶

Returns the depth offset value

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

Getter Method

Signature DepthOffset

Returns:	the depth offset builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX9.0.0.

License requirements: None.

DepthOption¶

CenterlineDrillTurningBuilder.DepthOption¶

Returns or sets the depth option

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

Getter Method

Signature DepthOption

Returns:	the depth option
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderDepthTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DepthOption

Parameters:	depthOption (`NXOpen.CAM.CenterlineDrillTurningBuilderDepthTypes`) – the depth option

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DepthReference¶

CenterlineDrillTurningBuilder.DepthReference¶

Returns or sets the depth reference

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

Getter Method

Signature DepthReference

Returns:	the depth reference
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderDepthReferenceTypes`

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature DepthReference

Parameters:	depthReference (`NXOpen.CAM.CenterlineDrillTurningBuilderDepthReferenceTypes`) – the depth reference

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

DrillStep¶

CenterlineDrillTurningBuilder.DrillStep¶

Returns the drill step

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

Getter Method

Signature DrillStep

Returns:	the step
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

DrillStepModifier1¶

CenterlineDrillTurningBuilder.DrillStepModifier1¶

Returns the drill step modifier1

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

Getter Method

Signature DrillStepModifier1

Returns:	the step modifier1
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

DrillStepModifier2¶

CenterlineDrillTurningBuilder.DrillStepModifier2¶

Returns the drill step modifier2

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

Getter Method

Signature DrillStepModifier2

Returns:	the step modifier2
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

DrillingLocation¶

CenterlineDrillTurningBuilder.DrillingLocation¶

Returns or sets the drilling location

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

Getter Method

Signature DrillingLocation

Returns:	the drilling location
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderDrillingLocationTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DrillingLocation

Parameters:	drillingLocationMode (`NXOpen.CAM.CenterlineDrillTurningBuilderDrillingLocationTypes`) – the drilling location

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DwellType¶

CenterlineDrillTurningBuilder.DwellType¶

Returns or sets the dwell type

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

Getter Method

Signature DwellType

Returns:	the dwell type
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderDwellTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DwellType

Parameters:	dwellMode (`NXOpen.CAM.CenterlineDrillTurningBuilderDwellTypes`) – the dwell type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DwellValue¶

CenterlineDrillTurningBuilder.DwellValue¶

Returns the dwell value

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

Getter Method

Signature DwellValue

Returns:	the dwell value
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

EngageDistance¶

CenterlineDrillTurningBuilder.EngageDistance¶

Returns the engage distance

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

Getter Method

Signature EngageDistance

Returns:	the engage distance builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

EntranceDiameter¶

CenterlineDrillTurningBuilder.EntranceDiameter¶

Returns the entrance diameter

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

Getter Method

Signature EntranceDiameter

Returns:	the entrance diameter builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

FinalRetractDistance¶

CenterlineDrillTurningBuilder.FinalRetractDistance¶

Returns the retract distance for simulated cycles

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

Getter Method

Signature FinalRetractDistance

Returns:	the retract distance for simulated cycles
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX7.5.0.

License requirements: None.

FinalRetractType¶

CenterlineDrillTurningBuilder.FinalRetractType¶

Returns or sets the retract type for simulated cycles

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

Getter Method

Signature FinalRetractType

Returns:	the final retract type for simulated cycles
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderFinalRetractTypes`

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature FinalRetractType

Parameters:	finalRetractType (`NXOpen.CAM.CenterlineDrillTurningBuilderFinalRetractTypes`) – the retract type for simulated cycles

New in version NX7.5.0.

License requirements: None.

NonCuttingBuilder¶

CenterlineDrillTurningBuilder.NonCuttingBuilder¶

Returns the non-cutting builder

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

Getter Method

Signature NonCuttingBuilder

Returns:	the non-cutting builder
Return type:	`NXOpen.CAM.NcmTurningBuilder`

New in version NX6.0.0.

License requirements: None.

OffCenterDistance¶

CenterlineDrillTurningBuilder.OffCenterDistance¶

Returns the off center distance

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

Getter Method

Signature OffCenterDistance

Returns:	the off center distance builder
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

OutputOption¶

CenterlineDrillTurningBuilder.OutputOption¶

Returns or sets the output option

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

Getter Method

Signature OutputOption

Returns:	the output option mode
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderOutputOptionTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OutputOption

Parameters:	outputOptionMode (`NXOpen.CAM.CenterlineDrillTurningBuilderOutputOptionTypes`) – the output option mode

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

RepositionDistance¶

CenterlineDrillTurningBuilder.RepositionDistance¶

Returns the reposition distance

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

Getter Method

Signature RepositionDistance

Returns:	the reposition distance
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX7.5.0.

License requirements: None.

ReverseDirection¶

CenterlineDrillTurningBuilder.ReverseDirection¶

Returns or sets the reverse direction value

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

Getter Method

Signature ReverseDirection

Returns:	the reverse direction value
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ReverseDirection

Parameters:	isReverseDirection (bool) – the reverse direction value

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SafeOrDepartureDistance¶

CenterlineDrillTurningBuilder.SafeOrDepartureDistance¶

Returns the safe or departure distance

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

Getter Method

Signature SafeOrDepartureDistance

Returns:	the safe or departure distance
Return type:	`NXOpen.CAM.InheritableDoubleBuilder`

New in version NX6.0.0.

License requirements: None.

SpindleStop¶

CenterlineDrillTurningBuilder.SpindleStop¶

Returns or sets the spindle stop

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

Getter Method

Signature SpindleStop

Returns:	the spindle stop
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderSpindleStopTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SpindleStop

Parameters:	spindleStop (`NXOpen.CAM.CenterlineDrillTurningBuilderSpindleStopTypes`) – the spindle stop

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

StartPosition¶

CenterlineDrillTurningBuilder.StartPosition¶

Returns or sets the start position

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

Getter Method

Signature StartPosition

Returns:	the start position
Return type:	`NXOpen.CAM.CenterlineDrillTurningBuilderStartPositionTypes`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature StartPosition

Parameters:	startPositionMode (`NXOpen.CAM.CenterlineDrillTurningBuilderStartPositionTypes`) – the start position mode

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

StartPositionPoint¶

CenterlineDrillTurningBuilder.StartPositionPoint¶

Returns or sets the start position point

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

Getter Method

Signature StartPositionPoint

Returns:	the start position point
Return type:	`NXOpen.Point`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature StartPositionPoint

Parameters:	startPositionSpecifyPoint (`NXOpen.Point`) – the start position point

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

VariableIncrementList¶

CenterlineDrillTurningBuilder.VariableIncrementList¶

Returns the variable increment list

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

Getter Method

Signature VariableIncrementList

Returns:	the variable increment list
Return type:	`NXOpen.CAM.CenterlineDrillVariableIncrementBuilder`

New in version NX6.0.0.

License requirements: None.

Method Detail¶

GetCycleTrackingPoint¶

CenterlineDrillTurningBuilder.GetCycleTrackingPoint¶

Returns the cycle tracking point

Signature GetCycleTrackingPoint()

Returns:
Return type:	str

New in version NX10.0.2.

License requirements: None.

SetCycleTrackingPoint¶

CenterlineDrillTurningBuilder.SetCycleTrackingPoint¶

Sets the cycle tracking point

Signature SetCycleTrackingPoint(name)

Parameters:	name (str) –

New in version NX10.0.2.

License requirements: cam_base (“CAM BASE”)

Validate¶

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