All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PartInterfaces Interface CATINewHole

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---PartInterfaces.CATIShape
        |
        +---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(CATICkeParm_var&)
Returns parameter linked to hole diameter.
o GetDiameter(double&)
Returns 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(CATICkeParm_var&)
Returns parameter linked to hole thread depth.
o GetThreadDepth(double&)
Returns hole thread Depth.
o GetThreadDiameter(CATICkeParm_var&)
Returns parameter linked to hole thread diameter.
o GetThreadDiameter(double&)
Returns hole thread diameter.
o GetThreadPitch(CATICkeParm_var&)
Returns parameter linked to hole thread pitch.
o GetThreadPitch(double&)
Returns 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 SetThreaded(int)
Sets hole threading mode.
o SetThreadedBottomLimit(CATISpecObject_var&)
Sets the hole thread bottom limit.
o SetThreadedBottomType(int)
Sets the hole thread bottom type.

Methods


o GetAnchorType
public virtual void GetAnchorType(int& oAnchorType) = 0
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 void GetBottomType(int& oBottomType) = 0
Returns hole bottom type.
Parameters:
oBottomType
Hole bottom type, can be :
- Flat
- VBottom
- Trimmed
o GetContext
public virtual void GetContext(int& oContext) = 0
Returns hole context.
Parameters:
oContext
Hole context
o GetDiameter
public virtual void GetDiameter(CATICkeParm_var& oDiameterParm) = 0
Returns parameter linked to hole diameter.
Parameters:
oDiameterParm
Parameter linked to hole diameter.
o GetDiameter
public virtual void GetDiameter(double& oDiameter) = 0
Returns hole diameter.
Parameters:
oDiameter
Hole diameter.
o GetDirection
public virtual void GetDirection(CATISpecObject_var& oDirection) = 0
Returns hole direction.
Parameters:
oDirection
Hole direction.
o GetHoleType
public virtual void GetHoleType(int& oHoleType) = 0
Returns hole type.
Parameters:
oHoleType
hole type, can be :
- Simple
- Tapered
- Counterbored
- Countersunk
- Counterdrilled
o GetLimit
public virtual void GetLimit(CATISpecObject_var& oBottomLimit) = 0
Returns hole bottom limit.
Parameters:
oBottomLimit
Hole bottom limit. The limit object controls hole bottom limit.
o GetPosition
public virtual void GetPosition(CATMathPoint& oOrigin,
CATMathDirection& oDirection) = 0
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 void GetThreadDepth(CATICkeParm_var& oThreadDepthParm) = 0
Returns parameter linked to hole thread depth.
Parameters:
oThreadDepthParm
Parameter linked to hole thread depth parameter
o GetThreadDepth
public virtual void GetThreadDepth(double& oThreadDepth) = 0
Returns hole thread Depth.
Parameters:
oThreadDepth
Hole thread depth
o GetThreadDiameter
public virtual void GetThreadDiameter(CATICkeParm_var& oThreadDiameterParm) = 0
Returns parameter linked to hole thread diameter.
Parameters:
oThreadDiameterParm
Parameter linked to hole thread diameter
o GetThreadDiameter
public virtual void GetThreadDiameter(double& oThreadDiameter) = 0
Returns hole thread diameter.
Parameters:
oThreadDiameter
Hole thread diameter
o GetThreadPitch
public virtual void GetThreadPitch(CATICkeParm_var& oThreadPitchParm) = 0
Returns parameter linked to hole thread pitch.
Parameters:
oThreadPitchParm
Parameter linked to hole thread pitch parameter
o GetThreadPitch
public virtual void GetThreadPitch(double& oThreadPitch) = 0
Returns hole thread pitch.
Parameters:
oThreadPitch
Hole thread pitch
o GetThreadSide
public virtual int GetThreadSide()= 0
Returns the value of the direction of the Thread Side.
o GetThreadedBottomLimit
public virtual HRESULT GetThreadedBottomLimit(CATISpecObject_var& ohBottomLimit) = 0
Retrieves the hole thread bottom limit.
Parameters:
ohBottomLimit
The hole thread bottom limit.
o GetThreadedBottomType
public virtual HRESULT GetThreadedBottomType(int& oBottomType) = 0
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 void IsThreaded(int& oThreadMode) = 0
Returns hole threading mode.
Parameters:
oThreadMode
Hole threading mode.
If threaded : oThreadMode = Threaded.
If not threaded: oThreadMode = Smooth
o Reverse
public virtual void Reverse()= 0
Inverts hole direction.
o SetAnchorType
public virtual void SetAnchorType( const int iAnchorType) = 0
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 void SetBottomType( const int iBottomType) = 0
Sets hole bottom type.
Parameters:
iBottomType
Hole bottom type, can be :
- Flat
- VBottom
- Trimmed
o SetContext
public virtual void SetContext(int& iContext) = 0
Set hole context.
Parameters:
iContext
Hole context
o SetDiameter
public virtual void SetDiameter( const double iDiameter) = 0
Sets hole diameter.
Parameters:
iDiameter
Hole diameter.
o SetDirection
public virtual void SetDirection( const CATISpecObject_var& iDirection) = 0
Sets hole direction.
Parameters:
iDirection
Hole direction.
o SetHoleType
public virtual void SetHoleType( const int iHoleType) = 0
Sets hole type.
Parameters:
iHoleType
Hole type, can be :
- Simple
- Tapered
- Counterbored
- Countersunk
- Counterdrilled
o SetLimit
public virtual void SetLimit( const int iType,
const CATISpecObject_var& iBottomLimit) = 0
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 void SetOrigin( const CATMathPoint& iOrigin) = 0
Sets hole origin point.
Parameters:
iOrigin
Origin of the hole.
o SetThreadDepth
public virtual void SetThreadDepth( const double iThreadDepth) = 0
Sets hole thread depth.
Parameters:
iThreadDepth
Hole thread depth
o SetThreadDiameter
public virtual void SetThreadDiameter( const double iThreadDiameter) = 0
Sets hole thread diameter.
Parameters:
iThreadDiameter
Hole thread diameter
o SetThreadPitch
public virtual void SetThreadPitch( const double iThreadPitch) = 0
Sets hole thread pitch.
Parameters:
iThreadPitch
Hole thread pitch
o SetThreadSide
public virtual void SetThreadSide( const int iThreadSide) = 0
Sets the value of the direction of the Thread Side.
Parameters:
iThreadSide

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

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.