pycatia.assembly_interfaces.assembly_hole

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.assembly_interfaces.assembly_hole.AssemblyHole(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
CATAssemblyInterfaces.AssemblyFeature
AssemblyHole

Represents the AssemblyHole object.
property anchor_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnchorMode() As CatHoleAnchorMode

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
Returns:

enum cat_hole_anchor_mode

Return type:

int

property bottom_angle: Angle

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property BottomAngle() As Angle (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
Return type:

Angle

property bottom_limit: Limit

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property BottomLimit() As Limit (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
Return type:

Limit

property bottom_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property BottomType() As CatHoleBottomType

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
Returns:

enum cat_hole_bottom_type

Return type:

int

property diameter: Length

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Diameter() As Length (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
Return type:

Length

get_direction() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDirection(CATSafeArrayVariant 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]
Parameters:

io_direction (tuple) –

Return type:

None

get_origin() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetOrigin(CATSafeArrayVariant 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]
Parameters:

io_origin (tuple) –

Return type:

None

property head_angle: Angle

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property HeadAngle() As Angle (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
Return type:

Angle

property head_depth: Length

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property HeadDepth() As Length (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
Return type:

Length

property head_diameter: Length

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property HeadDiameter() As Length (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
Return type:

Length

set_direction(i_line: Reference, i_line_comp: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDirection(Reference iLine,
Product 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
Parameters:
Return type:

None

property sketch: Sketch

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Sketch() As Sketch (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
Return type:

Sketch

property sketch_component: Product

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SketchComponent() As Product (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
Return type:

Product

property type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Type() As CatHoleType

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
Returns:

enum cat_hole_type

Return type:

int