HoleMakingBuilder Class¶
-
class
NXOpen.CAM.
HoleMakingBuilder
¶ Bases:
NXOpen.CAM.OperationBuilder
Represents a HoleMaking Builder
To create a new instance of this class, use
NXOpen.CAM.OperationCollection.CreateHoleMakingBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AllowOversizeTool | Returns or sets the Allow Oversize Tool flag |
BlindHoleStockBuilder | Returns the blind hole stock builder (inheritable double) |
ChannelName | Returns or sets the channel’s name |
CheckFluteLength | Returns or sets the check flute length flag |
CheckToolLength | Returns or sets the check tool length flag |
ClrDistBuilder | Returns the Clearance Distance builder (inheritable double) |
ClrVertBuilder | Returns the clearance vertical builder (inheritable double) |
ControlPointType | Returns or sets the control point type |
CutParameters | Returns the cut parameter object |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndOfPath | Returns the end event builder |
EndUdeSet | Returns the end ude set |
EngageFeedRate | Returns or sets the Engage Feed Rate |
FeedsBuilder | Returns the feeds and speeds builder |
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 |
ModelDepthType | Returns or sets the model depth type |
MotionOutputBuilder | Returns the motion output builder |
Notes | Returns the notes builder |
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 |
OversizeToolPercentBuilder | Returns the oversize tool percent builder (inheritable double) |
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 |
RapidFeedRate | Returns or sets the Rapid Feed Rate |
RaptoOffsetBuilder | Returns the rapto offset builder (inheritable double) |
RaptoOffsetToggle | Returns or sets the rapto offset flag |
RetractDistance | Returns the Retract Distance builder (inheritable double) |
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
SafeClearance | Returns the safe clearance builder |
SelectToolFlag | Returns or sets the user selected tool |
StartOfPath | Returns the start event builder |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
ThruClearBuilder | Returns the thru clear builder (inheritable double) |
ToolAxisType | Returns or sets the tool axis mode |
ToolAxisVector | Returns or sets the tool axis vector |
ToolChangeSetting | Returns the tool change builder |
ToolPathEditor | Returns the Tool Path Editor Builder |
ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
UseQuery | Returns or sets the use query flag |
UseUserDefinedTp | Returns or sets the user defined tool path flag |
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 |
GetHoleAxisValues | Get the Hole Axis values |
GetObject | Returns the object currently being edited by this builder. |
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¶
HoleMakingBuilderControlPointTypes Enumeration | Available types for Control Point Type in Hole Making Operation |
HoleMakingBuilderModelDepthTypes Enumeration | Available types for model depth in Hole Making Operation |
HoleMakingBuilderToolAxisTypes Enumeration | the tool axis mode options |
Property Detail¶
AllowOversizeTool¶
-
HoleMakingBuilder.
AllowOversizeTool
¶ Returns or sets the Allow Oversize Tool flag
-------------------------------------
Getter Method
Signature
AllowOversizeTool
Returns: the Allow Oversize Tool flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowOversizeTool
Parameters: allowOversize (bool) – the Allow Oversize Tool flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
BlindHoleStockBuilder¶
-
HoleMakingBuilder.
BlindHoleStockBuilder
¶ Returns the blind hole stock builder (inheritable double)
-------------------------------------
Getter Method
Signature
BlindHoleStockBuilder
Returns: the blind hole stock builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
CheckFluteLength¶
-
HoleMakingBuilder.
CheckFluteLength
¶ Returns or sets the check flute length flag
-------------------------------------
Getter Method
Signature
CheckFluteLength
Returns: the check flute length flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckFluteLength
Parameters: checkFluteLength (bool) – the check flute length flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
CheckToolLength¶
-
HoleMakingBuilder.
CheckToolLength
¶ Returns or sets the check tool length flag
-------------------------------------
Getter Method
Signature
CheckToolLength
Returns: the check tool length flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckToolLength
Parameters: checkToolLength (bool) – the check tool length flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ClrDistBuilder¶
-
HoleMakingBuilder.
ClrDistBuilder
¶ Returns the Clearance Distance builder (inheritable double)
-------------------------------------
Getter Method
Signature
ClrDistBuilder
Returns: the Clearance Distance builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
ClrVertBuilder¶
-
HoleMakingBuilder.
ClrVertBuilder
¶ Returns the clearance vertical builder (inheritable double)
-------------------------------------
Getter Method
Signature
ClrVertBuilder
Returns: the clearance vertical builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
ControlPointType¶
-
HoleMakingBuilder.
ControlPointType
¶ Returns or sets the control point type
-------------------------------------
Getter Method
Signature
ControlPointType
Returns: the control point type Return type: NXOpen.CAM.HoleMakingBuilderControlPointTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ControlPointType
Parameters: controlPoint ( NXOpen.CAM.HoleMakingBuilderControlPointTypes
) – the control point typeNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
CutParameters¶
-
HoleMakingBuilder.
CutParameters
¶ Returns the cut parameter object
-------------------------------------
Getter Method
Signature
CutParameters
Returns: Return type: NXOpen.CAM.CutParameters
New in version NX6.0.0.
License requirements: None.
EngageFeedRate¶
-
HoleMakingBuilder.
EngageFeedRate
¶ Returns or sets the Engage Feed Rate
-------------------------------------
Getter Method
Signature
EngageFeedRate
Returns: The Engage Feed Rate value Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EngageFeedRate
Parameters: engageFeed (float) – The Engage Feed Rate value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
FeedsBuilder¶
-
HoleMakingBuilder.
FeedsBuilder
¶ Returns the feeds and speeds builder
-------------------------------------
Getter Method
Signature
FeedsBuilder
Returns: the feeds and speeds builder Return type: NXOpen.CAM.FeedsBuilder
New in version NX5.0.0.
License requirements: None.
ModelDepthType¶
-
HoleMakingBuilder.
ModelDepthType
¶ Returns or sets the model depth type
-------------------------------------
Getter Method
Signature
ModelDepthType
Returns: the model depth type Return type: NXOpen.CAM.HoleMakingBuilderModelDepthTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ModelDepthType
Parameters: modelDepth ( NXOpen.CAM.HoleMakingBuilderModelDepthTypes
) – the model depth typeNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
OversizeToolPercentBuilder¶
-
HoleMakingBuilder.
OversizeToolPercentBuilder
¶ Returns the oversize tool percent builder (inheritable double)
-------------------------------------
Getter Method
Signature
OversizeToolPercentBuilder
Returns: the oversize tool percent builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
RapidFeedRate¶
-
HoleMakingBuilder.
RapidFeedRate
¶ Returns or sets the Rapid Feed Rate
-------------------------------------
Getter Method
Signature
RapidFeedRate
Returns: The Rapid Feed Rate value Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RapidFeedRate
Parameters: rapidFeed (float) – The Rapid Feed Rate value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
RaptoOffsetBuilder¶
-
HoleMakingBuilder.
RaptoOffsetBuilder
¶ Returns the rapto offset builder (inheritable double)
-------------------------------------
Getter Method
Signature
RaptoOffsetBuilder
Returns: the Rapto Offset builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
RaptoOffsetToggle¶
-
HoleMakingBuilder.
RaptoOffsetToggle
¶ Returns or sets the rapto offset flag
-------------------------------------
Getter Method
Signature
RaptoOffsetToggle
Returns: the rapto offset flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RaptoOffsetToggle
Parameters: raptoOffset (bool) – the rapto offset flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
ThruClearBuilder¶
-
HoleMakingBuilder.
ThruClearBuilder
¶ Returns the thru clear builder (inheritable double)
-------------------------------------
Getter Method
Signature
ThruClearBuilder
Returns: the thru clear builder Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX5.0.0.
License requirements: None.
ToolAxisType¶
-
HoleMakingBuilder.
ToolAxisType
¶ Returns or sets the tool axis mode
-------------------------------------
Getter Method
Signature
ToolAxisType
Returns: the integer value Return type: NXOpen.CAM.HoleMakingBuilderToolAxisTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolAxisType
Parameters: toolAxisType ( NXOpen.CAM.HoleMakingBuilderToolAxisTypes
) – the integer valueNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
ToolAxisVector¶
-
HoleMakingBuilder.
ToolAxisVector
¶ Returns or sets the tool axis vector
-------------------------------------
Getter Method
Signature
ToolAxisVector
Returns: the vector tag Return type: NXOpen.NXObject
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolAxisVector
Parameters: toolAxisVector ( NXOpen.NXObject
) – the vector tagNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
UseQuery¶
-
HoleMakingBuilder.
UseQuery
¶ Returns or sets the use query flag
-------------------------------------
Getter Method
Signature
UseQuery
Returns: the use query flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseQuery
Parameters: useQuery (bool) – the use query flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
UseUserDefinedTp¶
-
HoleMakingBuilder.
UseUserDefinedTp
¶ Returns or sets the user defined tool path flag
-------------------------------------
Getter Method
Signature
UseUserDefinedTp
Returns: the user defined tool path flag Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseUserDefinedTp
Parameters: useUserTp (bool) – the user defined tool path flag New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
HoleMakingBuilder.
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.