Hole (Object)

Hole Feature in Part Design.

Properties


Property AnchorMode() As
Returns the hole anchor mode.
This information is pertinent when hole type is Counterbored or Counterdrilled only.
Returns:
oMode The hole anchor mode (see for list of possible types)
Example:
The following example returns in holeAnchorMode the anchor mode of hole firstHole: 
 Set holeAnchorMode = firstHole.AnchorMode
Property BottomAngle() As (Read Only)
Returns the hole bottom angle.
This call is valid when the hole bottom type is : VBottom.
Returns:
oBottomAngle An Angle object controlling the hole bottom angle (see for more information)
Example:
The following example returns in holeBottomAngle the bottom angle of hole firstHole: 
 Set holeBottomAngle = firstHole.BottomAngle
Property BottomLimit() As (Read Only)
Returns the bottom limit.
This call is valid when the hole bottom type is : BlindHole or ThruHole.
Returns:
oBottomLimit A Limit object controlling the hole bottom limit (see for more information)
Example:
The following example returns in holeBottomLimit the bottom limit of hole firstHole: 
 Set holeBottomLimit = firstHole.BottomLimit
Property BottomType() As
Returns the hole bottom type.
Returns:
oBottomType The hole bottom type (see for list of possible types)
Example:
The following example returns in holeBottomType the bottom type of hole firstHole: 
 Set holeBottomType = firstHole.BottomType
Property CounterDrilledMode() As
Returns the mode of a counterdrilled hole .
Returns:
CDMode Value of the counterdrilled mode (see for list of possible types)
Example:
The following example returns in CDMode the CDMode of hole firsthole: 
 Set CDMode = firsthole.CounterDrilledMode
Property CounterSunkMode() As
Returns the mode of a countersunk hole .
Returns:
CSMode Value of the countersunk mode (see for list of possible types)
Example:
The following example returns in CSMode the CSMode of hole firsthole: 
 Set CSMode = firsthole.CounterSunkMode
Property Diameter() As (Read Only)
Returns the hole diameter.
Returns:
oDiameter A Length object controlling the hole diameter (see for more information)
Example:
The following example returns in holeDiam the diameter of hole firstHole: 
 Set holeDiam = firstHole.Diameter
Property HeadAngle() As (Read Only)
Returns the hole head angle.
This call is valid when the hole type is : Tapered or Counterdrilled or Countersunk.
Returns:
oHeadAngle An Angle object controlling the hole head angle (see for more information)
Example:
The following example returns in holeHeadAngle the head angle of hole firstHole: 
 Set holeHeadAngle = firstHole.HeadAngle
Property HeadDepth() As (Read Only)
Returns the hole head depth.
This call is valid when the hole type is : Counterbored or Counterdrilled or Countersunk.
Returns:
oHeadDepth A Length object controlling the hole head depth (see for more information)
Example:
The following example returns in holeHeadDepth the head depth of hole firstHole: 
 Set holeHeadDepth = firstHole.HeadDepth
Property HeadDiameter() As (Read Only)
Returns the hole head diameter.
This call is valid when the hole type is : Counterbored or Counterdrilled.
Returns:
oHeadDiameter A Length object controlling the hole head diameter (see for more information)
Example:
The following example returns in holeHeadDiam the head diameter of hole firstHole: 
 Set holeHeadDiam = firstHole.HeadDiameter
Property HoleThreadDescription() As (Read Only)
Returns the hole thread description parameter. This call is valid when the hole threading mode is : CATThreadedHoleThreading.
This call is valid only when a standard/user design table exists
Returns:
oThreadDescParam A Parameter object controlling the hole thread description (see for more information)
Example:
The following example returns in holeThreadDescription the thread description (M12 etc) of hole firstHole: 
 Set holeThreadDescription = firstHole.HoleThreadDescription
Property ThreadDepth() As (Read Only)
Returns the hole thread depth.
This call is valid when the hole threading mode is : CATThreadedHoleThreading.
Returns:
oThreadDepth A Length object controlling the hole thread depth (see for more information)
Example:
The following example returns in holeThreadDepth the thread depth of hole firstHole: 
 Set holeThreadDepth = firstHole.ThreadDepth
Property ThreadDiameter() As (Read Only)
Returns the hole thread diameter.
This call is valid when the hole threading mode is : CATThreadedHoleThreading.
Returns:
oThreadDiameter A Length object controlling the hole thread diameter (see for more information)
Example:
The following example returns in holeThreadDiameter the thread diameter of hole firstHole: 
 Set holeThreadDiameter = firstHole.ThreadDiameter
Property ThreadPitch() As (Read Only)
Returns the hole thread pitch.
This call is valid when the hole threading mode is : CATThreadedHoleThreading.
Returns:
oThreadPitch A Length object controlling the hole thread pitch (see for more information)
Example:
The following example returns in holeThreadPitch the thread pitch of hole firstHole: 
 Set holeThreadPitch = firstHole.ThreadPitch
Property ThreadSide() As
Returns the hole thread side.
Returns:
oThreadSide The hole thread side (see for list of possible sides)
Example:
The following example returns in holeThreadSide the thread side of hole firstHole: 
 Set holeThreadSide = firstHole.ThreadSide
Property ThreadingMode() As
Returns the hole threading mode.
Returns:
oThreadingMode The hole threading mode (see for list of possible types)
Example:
The following example returns in holeThreadingMode the threading mode of hole firstHole: 
 Set holeThreadingMode = firstHole.ThreadingMode
Property Type() As
Returns the hole type.
Returns:
oType The hole type (see for list of possible types)
Example:
The following example returns in holeType the type of hole firstHole: 
 Set holeType = firstHole.Type

Methods


Sub CreateStandardThreadDesignTable( iStandardType)
Creates a Standard Thread design table .
This call is valid when the hole threading mode is : CATThreadedHoleThreading.
Parameters:
iStandardType
Standard type for thread (see for list of possible types)
Example:
The following example creates a standard table for MetricThinPitch for hole firstHole: 
 firstHole.CreateStandardThreadDesignTable catHoleMetricThinPitch
Sub CreateUserStandardDesignTable( iStandardName, iPath)
Creates a UserStandard Thread design table .
This call is valid when the hole threading mode is : CATThreadedHoleThreading.
Parameters:
iStandardName
Name of the UserStandard thread. iStandardName should be empty if filepath is to be defined.
iPath
Path of the UserStandard file. iPath is empty if the filepath is already defined through CATReffilesPath.
Example1:
The following example creates a standard table for UserStandard for hole firstHole. The file path is already defined thru CATReffilesPath: 
 firstHole.CreateUserStandardDesignTable "UserStandard",""
Example2:
The following example creates a standard table for UserStandard for hole firstHole when file path is not defined thru CATReffilesPath: 
 firstHole.CreateUserStandardDesignTable "","E:\user\standard\UserStandard.txt"
Sub GetDirection( ioDirection)
Returns the hole direction with absolute coordinates.
It provides a safe array with 3 elements : X, Y, Z direction coordinates
Returns:
oDirection The direction coordinates
Example:
The following example returns in dirArray the direction coordinates of hole firstHole: 
 Call firstHole.GetDirection dirArray
 Set x = dirArray[1]
 Set y = dirArray[2]
 Set z = dirArray[3]
Sub GetOrigin( ioOrigin)
Returns the origin point which the hole is anchored to.
This point belongs to a tangent plane.
Returns:
oOrigin A Safe Array made up of 3 doubles : X, Y, Z - Hole origin point coordinates
Example:
The following example returns in coordArray the coordinates of hole firstHole: 
 Call firstHole.GetOrigin coordArray
 Set x = coordArray[1]
 Set y = coordArray[2]
 Set z = coordArray[3]
Sub Reverse()
Reverses the hole direction .
Example:
The following example reverses the current direction of hole firstHole: 
 firstHole.Reverse()
Sub SetDirection( iDirection)
Sets the hole associative direction.
Parameters:
iDirection
A Reference object to an edge or a line (see for more information)
The following objects are supported: , and .
Example:
The following example sets the support direction of hole firstHole with holeDirRef direction reference : 
 firstHole.SetDirection holeDirref
Sub SetOrigin( iX, iY, iZ)
Sets the origin point which the hole is anchored to.
If mandatory, the entry point will be projected onto a tangent plane.
Parameters:
iX
Origin point x absolute coordinate
iY
Origin point y absolute coordinate
iZ
Origin point z absolute coordinate
Example:
The following example sets the coordinates of hole firstHole to 10., 20., -5. : 
 firstHole.SetOrigin 10., 20., 5.