All Frameworks  Class Hierarchy  This Framework  Indexes   

PartInterfaces Interface CATINewHole

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATINewHole

Class to manage hole feature.
Role: Class CATINewHole inherits from CATIShape. Methods defined below are specifics to hole feature. They manage position, direction, type, diameter, anchorpoint of hole feature.

See also:
CATIShape


Method Index


o GetAnchorType(int&)
Returns hole anchor mode.
o GetBottomType(int&)
Returns hole bottom type.
o GetContext(int&)
Returns hole context.
o GetDiameter(double&)
Returns hole diameter.
o GetDiameter(CATICkeParm_var&)
Returns parameter linked to hole diameter.
o GetDirection(CATISpecObject_var&)
Returns hole direction.
o GetHoleType(int&)
Returns hole type.
o GetLimit(CATISpecObject_var&)
Returns hole bottom limit.
o GetPosition(CATMathPoint&,CATMathDirection&)
Returns hole origin point and hole direction.
o GetThreadDepth(double&)
Returns hole thread Depth.
o GetThreadDepth(CATICkeParm_var&)
Returns parameter linked to hole thread depth.
o GetThreadDiameter(double&)
Returns hole thread diameter.
o GetThreadDiameter(CATICkeParm_var&)
Returns parameter linked to hole thread diameter.
o GetThreadPitch(double&)
Returns hole thread pitch.
o GetThreadPitch(CATICkeParm_var&)
Returns parameter linked to hole thread pitch.
o GetThreadSide()
Returns the value of the direction of the Thread Side.
o GetThreadedBottomLimit(CATISpecObject_var&)
Retrieves the hole thread bottom limit.
o GetThreadedBottomType(int&)
Retrieves the hole thread bottom type.
o IsThreaded(int&)
Returns hole threading mode.
o Reverse()
Inverts hole direction.
o SetAnchorType(int)
Sets hole anchor mode.
o SetBottomType(int)
Sets hole bottom type.
o SetContext(int&)
Set hole context.
o SetDiameter(double)
Sets hole diameter.
o SetDirection(CATISpecObject_var&)
Sets hole direction.
o SetHoleType(int)
Sets hole type.
o SetLimit(int,CATISpecObject_var&)
Sets hole bottom limit.
o SetOrigin(CATMathPoint&)
Sets hole origin point.
o SetThreadDepth(double)
Sets hole thread depth.
o SetThreadDiameter(double)
Sets hole thread diameter.
o SetThreadPitch(double)
Sets hole thread pitch.
o SetThreadSide(int)
Sets the value of the direction of the Thread Side.
o SetThreadedBottomLimit(CATISpecObject_var&)
Sets the hole thread bottom limit.
o SetThreadedBottomType(int)
Sets the hole thread bottom type.
o SetThreaded(int)
Sets hole threading mode.

Methods


o GetAnchorType
public virtual GetAnchorType( oAnchorType)
Returns hole anchor mode. This information is pertinent for Counterbored or Counterdrilled hole only.
Parameters:
oAnchorType
Anchor mode, can be :
- Extreme = ExtPt
- Middle = MidPt
o GetBottomType
public virtual GetBottomType( oBottomType)
Returns hole bottom type.
Parameters:
oBottomType
Hole bottom type, can be :
- Flat
- VBottom
- Trimmed
o GetContext
public virtual GetContext( oContext)
Returns hole context.
Parameters:
oContext
Hole context
o GetDiameter
public virtual GetDiameter( oDiameter)
Returns hole diameter.
Parameters:
oDiameter
Hole diameter.
o GetDiameter
public virtual GetDiameter( oDiameterParm)
Returns parameter linked to hole diameter.
Parameters:
oDiameterParm
Parameter linked to hole diameter.
o GetDirection
public virtual GetDirection( oDirection)
Returns hole direction.
Parameters:
oDirection
Hole direction.
o GetHoleType
public virtual GetHoleType( oHoleType)
Returns hole type.
Parameters:
oHoleType
hole type, can be :
- Simple
- Tapered
- Counterbored
- Countersunk
- Counterdrilled
o GetLimit
public virtual GetLimit( oBottomLimit)
Returns hole bottom limit.
Parameters:
oBottomLimit
Hole bottom limit. The limit object controls hole bottom limit.
o GetPosition
public virtual GetPosition( oOrigin,
oDirection)
Returns hole origin point and hole direction.
Parameters:
oOrigin
Origin of the hole.
oDirection
Hole direction. Returned direction corresponds to drilling direction.
o GetThreadDepth
public virtual GetThreadDepth( oThreadDepth)
Returns hole thread Depth.
Parameters:
oThreadDepth
Hole thread depth
o GetThreadDepth
public virtual GetThreadDepth( oThreadDepthParm)
Returns parameter linked to hole thread depth.
Parameters:
oThreadDepthParm
Parameter linked to hole thread depth parameter
o GetThreadDiameter
public virtual GetThreadDiameter( oThreadDiameter)
Returns hole thread diameter.
Parameters:
oThreadDiameter
Hole thread diameter
o GetThreadDiameter
public virtual GetThreadDiameter( oThreadDiameterParm)
Returns parameter linked to hole thread diameter.
Parameters:
oThreadDiameterParm
Parameter linked to hole thread diameter
o GetThreadPitch
public virtual GetThreadPitch( oThreadPitch)
Returns hole thread pitch.
Parameters:
oThreadPitch
Hole thread pitch
o GetThreadPitch
public virtual GetThreadPitch( oThreadPitchParm)
Returns parameter linked to hole thread pitch.
Parameters:
oThreadPitchParm
Parameter linked to hole thread pitch parameter
o GetThreadSide
public virtual GetThreadSide()
Returns the value of the direction of the Thread Side.
o GetThreadedBottomLimit
public virtual GetThreadedBottomLimit( ohBottomLimit)
Retrieves the hole thread bottom limit.
Parameters:
ohBottomLimit
The hole thread bottom limit.
o GetThreadedBottomType
public virtual GetThreadedBottomType( oBottomType)
Retrieves the hole thread bottom type.
Parameters:
oBottomType
The hole thread bottom type can be :
- 0 - Dimension
- 1 - Support Depth
- 2 - Up-To-Plane
o IsThreaded
public virtual IsThreaded( oThreadMode)
Returns hole threading mode.
Parameters:
oThreadMode
Hole threading mode.
If threaded : oThreadMode = Threaded.
If not threaded: oThreadMode = Smooth
o Reverse
public virtual Reverse()
Inverts hole direction.
o SetAnchorType
public virtual SetAnchorType( const iAnchorType)
Sets hole anchor mode. This information is pertinent for Counterbored or Counterdrilled hole only.
Parameters:
iAnchorType
Anchor mode, can be :
- Extreme = ExtPt
- Middle = MidPt
o SetBottomType
public virtual SetBottomType( const iBottomType)
Sets hole bottom type.
Parameters:
iBottomType
Hole bottom type, can be :
- Flat
- VBottom
- Trimmed
o SetContext
public virtual SetContext( iContext)
Set hole context.
Parameters:
iContext
Hole context
o SetDiameter
public virtual SetDiameter( const iDiameter)
Sets hole diameter.
Parameters:
iDiameter
Hole diameter.
o SetDirection
public virtual SetDirection( const iDirection)
Sets hole direction.
Parameters:
iDirection
Hole direction.
o SetHoleType
public virtual SetHoleType( const iHoleType)
Sets hole type.
Parameters:
iHoleType
Hole type, can be :
- Simple
- Tapered
- Counterbored
- Countersunk
- Counterdrilled
o SetLimit
public virtual SetLimit( const iType,
const iBottomLimit)
Sets hole bottom limit.
Parameters:
iType.
Type of the bottom limit, can be:
- catOffsetLimit : Shape is limited with an offset value.
- catUpToNextLimit : shape is limited with the next boundary encountered.
- catUpToLastLimit : shape is limited with the last boundary encountered.
- catUpToPlaneLimit : shape is limited with a selected plane.
- catUpToSurfaceLimit: shape is limited with a selected surface.
- catUpThruNextLimit : shape is limited with the next boundary encountered. And relimiting body cuts the shape entirely once only.
iBottomLimit
Hole bottom limit. The limit object controls hole bottom limit.
o SetOrigin
public virtual SetOrigin( const iOrigin)
Sets hole origin point.
Parameters:
iOrigin
Origin of the hole.
o SetThreadDepth
public virtual SetThreadDepth( const iThreadDepth)
Sets hole thread depth.
Parameters:
iThreadDepth
Hole thread depth
o SetThreadDiameter
public virtual SetThreadDiameter( const iThreadDiameter)
Sets hole thread diameter.
Parameters:
iThreadDiameter
Hole thread diameter
o SetThreadPitch
public virtual SetThreadPitch( const iThreadPitch)
Sets hole thread pitch.
Parameters:
iThreadPitch
Hole thread pitch
o SetThreadSide
public virtual SetThreadSide( const iThreadSide)
Sets the value of the direction of the Thread Side.
Parameters:
iThreadSide

Legal Values <\b>
0 : Right
1 : Left
o SetThreadedBottomLimit
public virtual SetThreadedBottomLimit( ihBottomLimit)
Sets the hole thread bottom limit.
Parameters:
ihBottomLimit
The hole thread bottom limit.
o SetThreadedBottomType
public virtual SetThreadedBottomType( const iBottomType)
Sets the hole thread bottom type.
Parameters:
oBottomType
The hole thread bottom type can be :
- 0 - Dimension
- 1 - Support Depth
- 2 - Up-To-Plane
o SetThreaded
public virtual SetThreaded( const iThreadMode)
Sets hole threading mode.
Parameters:
iThreadMode
Hole threading mode.
If threaded : iThreadMode = Threaded
If not threaded: iThreadMode = Smooth

This object is included in the file: CATINewHole.h
If needed, your Imakefile.mk should include the module: CATPartInterfaces

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