TurningToolBuilder Class¶
-
class
NXOpen.CAM.
TurningToolBuilder
¶ Bases:
NXOpen.CAM.ToolBuilder
Represents a Turning 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 |
HolderAngleBuilder | Returns the holder angle builder (inheritable double) |
HolderDescription | Returns or sets the holder description |
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 |
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) |
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 |
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. |
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) |
RightAngleBuilder | Returns the right angle builder (inheritable double) |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
ThicknessBuilder | Returns the thickness builder (inheritable double) |
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. |
GetMaterial | Get tool material @return |
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¶
TurningToolBuilderHolderShankTypes Enumeration | the available turn holder shank types |
TurningToolBuilderInsertPositions Enumeration | the available insert positions |
Property Detail¶
HolderAngleBuilder¶
-
TurningToolBuilder.
HolderAngleBuilder
¶ Returns the holder angle builder (inheritable double)
-------------------------------------
Getter Method
Signature
HolderAngleBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
HolderLengthBuilder¶
-
TurningToolBuilder.
HolderLengthBuilder
¶ Returns the turn holder length builder (inheritable double)
-------------------------------------
Getter Method
Signature
HolderLengthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
HolderLock¶
-
TurningToolBuilder.
HolderLock
¶ Returns or sets the lock turn holder toggle
-------------------------------------
Getter Method
Signature
HolderLock()
Returns: the lock turn holder toggle Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HolderLock(holderLock)
Parameters: holderLock (bool) – the lock turn holder toggle New in version NX5.0.0.
License requirements: None.
HolderShankLineBuilder¶
-
TurningToolBuilder.
HolderShankLineBuilder
¶ Returns the turn holder shank line builder (inheritable double)
-------------------------------------
Getter Method
Signature
HolderShankLineBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
HolderShankType¶
-
TurningToolBuilder.
HolderShankType
¶ Returns or sets the turn holder shank type
-------------------------------------
Getter Method
Signature
HolderShankType()
Returns: Return type: NXOpen.CAM.TurningToolBuilderHolderShankTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HolderShankType(holderShankType)
Parameters: holderShankType ( NXOpen.CAM.TurningToolBuilderHolderShankTypes
) –New in version NX5.0.0.
License requirements: None.
HolderShankWidthBuilder¶
-
TurningToolBuilder.
HolderShankWidthBuilder
¶ Returns the turn holder shank width builder (inheritable double)
-------------------------------------
Getter Method
Signature
HolderShankWidthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
HolderUse¶
-
TurningToolBuilder.
HolderUse
¶ Returns or sets the use turn holder toggle
-------------------------------------
Getter Method
Signature
HolderUse()
Returns: the use turn holder toggle Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HolderUse(holderUse)
Parameters: holderUse (bool) – the use turn holder toggle New in version NX5.0.0.
License requirements: None.
HolderWidthBuilder¶
-
TurningToolBuilder.
HolderWidthBuilder
¶ Returns the turn holder width builder (inheritable double)
-------------------------------------
Getter Method
Signature
HolderWidthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
InsertLengthBuilder¶
-
TurningToolBuilder.
InsertLengthBuilder
¶ Returns the insert length builder (inheritable double)
-------------------------------------
Getter Method
Signature
InsertLengthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
InsertPosition¶
-
TurningToolBuilder.
InsertPosition
¶ Returns or sets the insert position
-------------------------------------
Getter Method
Signature
InsertPosition()
Returns: Return type: NXOpen.CAM.TurningToolBuilderInsertPositions
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InsertPosition(insertPosition)
Parameters: insertPosition ( NXOpen.CAM.TurningToolBuilderInsertPositions
) –New in version NX5.0.0.
License requirements: None.
InsertWidthBuilder¶
-
TurningToolBuilder.
InsertWidthBuilder
¶ Returns the insert width builder (inheritable double)
-------------------------------------
Getter Method
Signature
InsertWidthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
LeftAngleBuilder¶
-
TurningToolBuilder.
LeftAngleBuilder
¶ Returns the left angle builder (inheritable double)
-------------------------------------
Getter Method
Signature
LeftAngleBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ManageToolPartBuilder¶
-
TurningToolBuilder.
ManageToolPartBuilder
¶ Returns the manage tool part builder
-------------------------------------
Getter Method
Signature
ManageToolPartBuilder()
Returns: Return type: NXOpen.CAM.ManageToolPartBuilder
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
MaxDepthBuilder¶
-
TurningToolBuilder.
MaxDepthBuilder
¶ Returns the max.
depth builder (inheritable double)
-------------------------------------
Getter Method
Signature
MaxDepthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MaxDepthToggle¶
-
TurningToolBuilder.
MaxDepthToggle
¶ Returns or sets the max.
depth toggle
-------------------------------------
Getter Method
Signature
MaxDepthToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxDepthToggle(maxDepthToggle)
Parameters: maxDepthToggle (bool) – New in version NX5.0.0.
License requirements: None.
MaxFacingDiameterBuilder¶
-
TurningToolBuilder.
MaxFacingDiameterBuilder
¶ Returns the max.
facing diameter builder (inheritable double)
-------------------------------------
Getter Method
Signature
MaxFacingDiameterBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MaxFacingDiameterToggle¶
-
TurningToolBuilder.
MaxFacingDiameterToggle
¶ Returns or sets the max.
facing diameter toggle
-------------------------------------
Getter Method
Signature
MaxFacingDiameterToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxFacingDiameterToggle(maxFacingDiameterToggle)
Parameters: maxFacingDiameterToggle (bool) – New in version NX5.0.0.
License requirements: None.
MaxToolReachBuilder¶
-
TurningToolBuilder.
MaxToolReachBuilder
¶ Returns the max.
tool reach builder (inheritable double)
-------------------------------------
Getter Method
Signature
MaxToolReachBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MaxToolReachToggle¶
-
TurningToolBuilder.
MaxToolReachToggle
¶ Returns or sets the max.
tool reach toggle
-------------------------------------
Getter Method
Signature
MaxToolReachToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxToolReachToggle(maxToolReachToggle)
Parameters: maxToolReachToggle (bool) – New in version NX5.0.0.
License requirements: None.
McsSpindleGroup¶
-
TurningToolBuilder.
McsSpindleGroup
¶ Returns or sets the MCS spindle group
-------------------------------------
Getter Method
Signature
McsSpindleGroup()
Returns: the tag of the MCS spindle group Return type: NXOpen.CAM.NCGroup
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
McsSpindleGroup(mcsSpindleGroup)
Parameters: mcsSpindleGroup ( NXOpen.CAM.NCGroup
) – the tag of the MCS spindle groupNew in version NX7.5.0.
License requirements: None.
MinBoringDiameterBuilder¶
-
TurningToolBuilder.
MinBoringDiameterBuilder
¶ Returns the min.
boring diameter builder (inheritable double)
-------------------------------------
Getter Method
Signature
MinBoringDiameterBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MinBoringDiameterToggle¶
-
TurningToolBuilder.
MinBoringDiameterToggle
¶ Returns or sets the min.
boring diameter toggle
-------------------------------------
Getter Method
Signature
MinBoringDiameterToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinBoringDiameterToggle(minBoringDiameterToggle)
Parameters: minBoringDiameterToggle (bool) – New in version NX5.0.0.
License requirements: None.
MinFacingDiameterBuilder¶
-
TurningToolBuilder.
MinFacingDiameterBuilder
¶ Returns the min.
facing diameter builder (inheritable double)
-------------------------------------
Getter Method
Signature
MinFacingDiameterBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
MinFacingDiameterToggle¶
-
TurningToolBuilder.
MinFacingDiameterToggle
¶ Returns or sets the min.
facing diameter toggle
-------------------------------------
Getter Method
Signature
MinFacingDiameterToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinFacingDiameterToggle(minFacingDiameterToggle)
Parameters: minFacingDiameterToggle (bool) – New in version NX5.0.0.
License requirements: None.
NoseRadiusBuilder¶
-
TurningToolBuilder.
NoseRadiusBuilder
¶ Returns the nose radius builder (inheritable double)
-------------------------------------
Getter Method
Signature
NoseRadiusBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
NoseWidthBuilder¶
-
TurningToolBuilder.
NoseWidthBuilder
¶ Returns the nose width builder (inheritable double)
-------------------------------------
Getter Method
Signature
NoseWidthBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
OrientAngleBuilder¶
-
TurningToolBuilder.
OrientAngleBuilder
¶ Returns the orient angle builder (inheritable double)
-------------------------------------
Getter Method
Signature
OrientAngleBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
RightAngleBuilder¶
-
TurningToolBuilder.
RightAngleBuilder
¶ Returns the right angle builder (inheritable double)
-------------------------------------
Getter Method
Signature
RightAngleBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ThicknessBuilder¶
-
TurningToolBuilder.
ThicknessBuilder
¶ Returns the thickness builder (inheritable double)
-------------------------------------
Getter Method
Signature
ThicknessBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
TrackingBuilder¶
-
TurningToolBuilder.
TrackingBuilder
¶ Returns the tracking point builder
-------------------------------------
Getter Method
Signature
TrackingBuilder()
Returns: Return type: NXOpen.CAM.TrackingBuilder
New in version NX5.0.1.
License requirements: cam_base (“CAM BASE”)
XMountBuilder¶
-
TurningToolBuilder.
XMountBuilder
¶ Returns the x mount builder (inheritable double)
-------------------------------------
Getter Method
Signature
XMountBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
YMountBuilder¶
-
TurningToolBuilder.
YMountBuilder
¶ Returns the y mount builder (inheritable double)
-------------------------------------
Getter Method
Signature
YMountBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
TurningToolBuilder.
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.