All Frameworks  Object Hierarchy  This Framework  Indexes

AssemblyHole (Object)

Represents the AssemblyHole object.

Property Index

AnchorMode
Returns or sets the hole anchor mode.
BottomAngle
Returns the hole bottom angle.
BottomLimit
Returns the hole bottom limit.
BottomType
Returns or sets the hole bottom type.
Diameter
Returns the hole diameter.
HeadAngle
Returns the hole head angle.
HeadDepth
Returns the hole head depth.
HeadDiameter
Returns the hole head diameter.
SketchComponent
Returns the component containing the hole positioning sketch.
Sketch
Returns the hole positioning sketch.
Type
Returns or sets the hole type.

Method Index

GetDirection
Retrieves the hole direction vector components.
GetOrigin
Retrieves the origin point to which the hole is anchored.
SetDirection
Sets the hole axis direction.

Properties


o Property AnchorMode() As
Returns or sets the hole anchor mode.
This property is valid when the hole type is Counterbored or Counterdrilled.
Example:
The following example saves in holeAnchorMode the anchor mode of the hole assemblyHole and sets it so that the anchor mode will now be set to the middle of its head. 
 Dim holeAnchorMode
 Set holeAnchorMode = assemblyHole.AnchorMode
 assemblyHole.AnchorMode = catMiddlePointHoleAnchor
o Property BottomAngle() As (Read Only)
Returns the hole bottom angle.
This property is valid when the hole bottom type is VBottom. The hole bottom angle is returned as a Angle object.
Example:
The following example retrieves in holeBottomAngle the bottom angle of the hole assemblyHole. 
 Dim holeBottomAngle As Angle
 Set holeBottomAngle = assemblyHole.BottomAngle
o Property BottomLimit() As (Read Only)
Returns the hole bottom limit.
This limit manages the way the hole is ended. It is returned as a Limit object.
Example:
The following example retrieves in limit the bottom limit of the hole assemblyHole. 
 Dim limit As Limit
 Set limit = assemblyHole.BottomLimit
o Property BottomType() As
Returns or sets the hole bottom type.
Example:
The following example saves in holeBottomType the bottom type of the hole assemblyHole and sets it so that the bottom will now be a V-like one. 
 Dim holeBottomType
 Set holeBottomType = assemblyHole.BottomType
 assemblyHole.BottomType = catVHoleBottom
o Property Diameter() As (Read Only)
Returns the hole diameter.
It is returned as a Length object.
Example:
The following example retrieves in holeDiam the diameter of the hole assemblyHole. 
 Dim holeDiam As Length
 Set holeDiam = assemblyHole.Diameter
o Property HeadAngle() As (Read Only)
Returns the hole head angle.
This property is valid when the hole type is Tapered, Counterdrilled or Countersunk. The hole head angle is returned as a Angle object.
Example:
The following example retrieves in holeHeadAngle the head angle of the hole assemblyHole. 
 Dim holeHeadAngle As Angle
 Set holeHeadAngle = assemblyHole.HeadAngle
o Property HeadDepth() As (Read Only)
Returns the hole head depth.
This property is valid when the hole type is Counterbored, Counterdrilled or Countersunk. The hole head depth is returned as a Length object.
Example:
The following example retrieves in holeHeadDepth the head depth of the hole assemblyHole. 
 Dim holeHeadDepth As Length
 Set holeHeadDepth = assemblyHole.HeadDepth
o Property HeadDiameter() As (Read Only)
Returns the hole head diameter.
This property is valid when the hole type is Counterbored or Counterdrilled. The hole head diameter is returned as a Length object.
Example:
The following example retrieves in holeHeadDiam the head diameter of the hole assemblyHole. 
 Dim holeHeadDiam As Length
 Set holeHeadDiam = assemblyHole.HeadDiameter
o Property SketchComponent() As (Read Only)
Returns the component containing the hole positioning sketch.
Example:
The following example retrieves in skComp the component that contains the positioning sketch of the hole assemblyHole. 
 Dim skComp As Product
 Set skComp = assemblyHole.SketchComponent
o Property Sketch() As (Read Only)
Returns the hole positioning sketch.
Example:
The following example retrieves in sketch the positioning sketch of the hole assemblyHole. 
 Dim sketch As Sketch
 Set sketch = assemblyHole.Sketch
o Property Type() As
Returns or sets the hole type.
Example:
The following example saves in holeType the type of the hole assemblyHole, and then sets it so that it will now be a tapered hole. 
 Set holeType = assemblyHole.Type
 assemblyHole.Type = catTaperedHole

Methods


o Sub GetDirection( ioDirection)
Retrieves the hole direction vector components.
These components are expressed in millimeter according to the absolute coordinate system.
Parameters:
ioDirection
The direction vector components, as a safe array made up of three doubles: X, Y, Z
The array must be previously initialized.
Example:
The following example returns in dirArray the direction vector components of the hole assemblyHole. 
 Dim dirArray(2)
 Call assemblyHole.GetDirection(dirArray)
 Set x = dirArray[0]
 Set y = dirArray[1]
 Set z = dirArray[2]
o Sub GetOrigin( ioOrigin)
Retrieves the origin point to which the hole is anchored.
This point belongs to a plane tangent to the hole. The coordinates are expressed in millimeter according to the absolute coordinate system.
Parameters:
ioOrigin
The hole origin point coordinates, as a safe array made up of three doubles: X, Y, Z
The array must be previously initialized.
Example:
The following example returns in coordArray the coordinates of the hole assemblyHole. 
 Dim coordArray(2)
 Call assemblyHole.GetOrigin coordArray
 Set x = coordArray[0]
 Set y = coordArray[1]
 Set z = coordArray[2]
o Sub SetDirection( iLine,
iLineComp)
Sets the hole axis direction.
Parameters:
iLine
The hole axis direction, as a reference to a line or an edge.
iLineComp
The component containing the axis direction
Example:
The following example sets the axis direction of the hole assemblyHole with the dirRef line of the component dirComp. 
 assemblyHole.SetDirection dirRef, dirComp

Copyright © 2003, Dassault Systèmes. All rights reserved.