All Frameworks  Class Hierarchy  This Framework  Indexes

SurfaceMachiningAlgoInterfaces Interface CATIMfgMultiAxisAlgorithm

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIMfgMultiAxisAlgorithm
 

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


interface CATIMfgMultiAxisAlgorithm

Interface for Multi-axis Machining Algorithms.
Use CATInstantiateComponent to instanciate it with :


Method Index


o AddMacroAlongALineMotion(int,double,CATMathVector&)
Adds a motion along a line at the end of a macro.
o AddMacroAxialMotion(int,double)
Adds an axial motion at the end of a macro.
o AddMacroCircularMotion(int,double,double,double)
Adds a circular motion at the end of a macro.
o AddMacroRampingMotion(int,double,double,double)
Adds a ramping motion at the end of a macro.
o AddMacroSyntax(int,CATUnicodeString&)
Adds a user syntax at the end of a macro.
o AddMacroTangentMotion(int,double,double,double)
Adds a tangent motion at the end of a macro.
o AddMacroToAPlaneMotion(int,CATMathPlane&)
Adds a motion perpendicular to a plane at the end of a macro.
o ComputeToolPath(CATIContainer_var&,CATBaseUnknown_var&)
Runs algorithm.
o SetDirection(CATString&,CATMathVector&)
Sets a direction parameter.
o SetSurfacicGeometry(CATString&,CATLISTP(CATFace)&)
Sets a 2D geometry.
o SetTool(CATBaseUnknown_var&)
Sets a specific tool.
o SetValue(CATString&,double)
Sets a real parameter.
o SetValue(CATString&,int)
Sets a integer parameter.
o SetWireFrameGeometry(CATString&,CATLISTP(CATCurve)&)
Sets a 1D geometry.
o UnsetData()
Unsets all parameters and geometry, already set.

Methods


o AddMacroAlongALineMotion
public virtual HRESULT AddMacroAlongALineMotion( const int iMacro,
const double iDistance,
const CATMathVector& iLineDirection)=0
Adds a motion along a line at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iDistance
The length of the motion
iLineDirection
The direction of the motion
o AddMacroAxialMotion
public virtual HRESULT AddMacroAxialMotion( const int iMacro,
const double iDistance=10.)=0
Adds an axial motion at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iDistance
The length of the motion.
o AddMacroCircularMotion
public virtual HRESULT AddMacroCircularMotion( const int iMacro,
const double iAngularSector=90.,
const double iAngularOrientation=0.,
const double iRadius=10.)=0
Adds a circular motion at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iAngularSector
The angular sector of the motion
iAngularOrientation
The angular orientation of the motion
iRadius
The radius of the motion (> 0.)
Returns:
S_OK
if the method succeeds
E_FAIL
if motion is added after an axial motion
o AddMacroRampingMotion
public virtual HRESULT AddMacroRampingMotion( const int iMacro,
const double iHorizontalSafetyDistance=10.,
const double iVerticalSafetyDistance=10.,
const double iRampingAngle=20.)=0
Adds a ramping motion at the end of a macro. Ths motion is not available on retract motions.
Parameters:
iMacro
Where motion is added 1:Approach / 3:LinkingApproach / 5:ReturnInALevelApproach
iHorizontalSafetyDistance
The horizontal safety distance of the motion
iVerticalSafetyDistance
The vertical safety distance of the motion
iRampingAngle
The ramping angle of the motion
Returns:
S_OK
if the method succeeds
E_FAIL
if motion is added after an axial motion or on a retract macro
o AddMacroSyntax
public virtual HRESULT AddMacroSyntax( const int iMacro,
const CATUnicodeString& iStatement)=0
Adds a user syntax at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iStatement
The word to add
o AddMacroTangentMotion
public virtual HRESULT AddMacroTangentMotion( const int iMacro,
const double iDistance=10.,
const double iVerticalAngle=0.,
const double iHorizontalAngle=0.)=0
Adds a tangent motion at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iDistance
The length of the motion.
iVerticalAngle
The vertical angle of the motion.
iHorizontalAngle
The horizontal angle of the motion.
Returns:
S_OK
if the method succeeds
E_FAIL
if motion is added after an axial motion
o AddMacroToAPlaneMotion
public virtual HRESULT AddMacroToAPlaneMotion( const int iMacro,
const CATMathPlane& iPlane)=0
Adds a motion perpendicular to a plane at the end of a macro.
Parameters:
iMacro
Where motion is added 1:Approach / 2:Retract / 3:LinkingApproach / 4:LinkingRetract / 5:ReturnInALevelApproach / 6:ReturnInALevelRetract
iPlane
The plane of the motion
Returns:
S_OK
if the method succeeds
E_FAIL
if motion is added after an axial motion
o ComputeToolPath
public virtual HRESULT ComputeToolPath( const CATIContainer_var& ihContainer,
CATBaseUnknown_var& ohToolPath)=0
Runs algorithm.
Parameters:
ihContainer
The tool path container of the process where the result is created
ohToolPath
The machining tool path computed
Returns:
S_OK
if the method succeeds
E_FAIL
if computation fails
o SetDirection
public virtual HRESULT SetDirection( const CATString& iDirectionName,
const CATMathVector& iDirection)=0
Sets a direction parameter.
Parameters:
iDirectionName
One of the following keys :
MfgAlgViewDirection
View direction
MfgAlgStartDirection
Start direction
iDirection
The direction in global axis system .
Returns:
S_OK
if the method succeeds
E_FAIL
if iDirectionName is not valid
o SetSurfacicGeometry
public virtual HRESULT SetSurfacicGeometry( const CATString& iGeometryType,
const CATLISTP(CATFace)& iListOfFaces)=0
Sets a 2D geometry.
Parameters:
iGeometryType
One of the following keys :
MfgAlgParts
Part
iListOfFaces
The list of faces defining the geometry.
Returns:
S_OK
if the method succeeds
E_FAIL
if iGeometryType is not valid or if iListOfFaces is empty
o SetTool
public virtual HRESULT SetTool( const CATBaseUnknown_var& ihTool)=0
Sets a specific tool. If this method is not called, ball end mill tool of 10mm diameter will be taken into account during computation.
Parameters:
ihTool
The manufacturing tool (CATIMfgTool)
o SetValue
public virtual HRESULT SetValue( const CATString& iAttributeName,
const double iAttributeValue)=0
Sets a real parameter.
Parameters:
iAttributeName
One of the following keys :
MfgAlgMachiningTolerance
Machining tolerance (>0.)
MfgAlgMaxDiscretizationStep
Maximum discretization step (>0.)
MfgAlgMaxDiscretizationAngle
Maximum discretization angle (>0.)
MfgAlgMaxDistance
StepOver - Distance on part (>0.)
MfgAlgOffsetOnGuide1
Offset on guide 1 (for multi-axis contour-driven only)
MfgAlgOffsetOnGuide2
Offset on guide 2 (for multi-axis contour-driven only)
iAttributeValue
The defined value of the parameter (in millimeter for lengths and degree for angles).
Returns:
S_OK
if the method succeeds
E_FAIL
if iAttributeName is not valid or if iAttributeValue is out of range
o SetValue
public virtual HRESULT SetValue( const CATString& iAttributeName,
const int iAttributeValue)=0
Sets a integer parameter.
Parameters:
iAttributeName
One of the following keys :
MfgAlgMachiningMode
Tool path style (1:Zigzag / 2:Oneway)
MfgAlgStepoverSide
Stepover side (1:left / -1:right)
MfgAlgContouringMode
Guiding strategy (1:BetweenContour / 2:ParallelContour) ) (for multi-axis contour-driven only)
MfgAlgFromToContour
Contour direction (1:FromContour / 2: ToContour) (for multi-axis contour-driven only)
MfgAlgPositionOnGuide1
Position on Guide1 (1:In / 2: Out / 3:On) (for multi-axis contour-driven only)
MfgAlgPositionOnGuide2
Position on Guide2 (1:In / 2: Out / 3:On) (for multi-axis contour-driven only)
iAttributeValue
The defined value of the parameter.
Returns:
S_OK
if the method succeeds
E_FAIL
if iAttributeName is not valid
o SetWireFrameGeometry
public virtual HRESULT SetWireFrameGeometry( const CATString& iGeometryType,
const CATLISTP(CATCurve)& iListOfCurves)=0
Sets a 1D geometry.
Parameters:
iGeometryType
One of the following keys :
MfgAlgLimitLine
Limiting contour
MfgAlgGuide1
First guide (for multi-axis contour-driven only)
MfgAlgGuide2
Second guide (for multi-axis contour-driven only)
MfgAlgStop1
First stop (for multi-axis contour-driven only)
MfgAlgStop2
Second stop (for multi-axis contour-driven only)
iListOfCurves
The list of curves defining the geometry.
Returns:
S_OK
if the method succeeds
E_FAIL
if iGeometryType is not valid
o UnsetData
public virtual HRESULT UnsetData()=0
Unsets all parameters and geometry, already set.

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

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