All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgToolPathCycle

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ManufacturingInterfaces.CATIMfgToolPath
        |
        +---ManufacturingInterfaces.CATIMfgTraject
          |
          +---ManufacturingInterfaces.CATIMfgCompoundTraject
            |
            +---CATIMfgToolPathCycle
 

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


interface CATIMfgToolPathCycle

Interface for management of machining cycle inside tool path model.
Role: A CATIMfgToolPathCycle object is a specialized CATIMfgCompoundTraject object.
As a CATIMfgCompoundTraject object, you can store on it reference values (feedrates,spindle,tool axis,....) and you can store the description of a tool path (using CATIMfgTPMultipleMotion, CATIMfgCompoundTraject, CATIMfgToolPathCycle or CATIMfgToolPathMotionCommand objects).
Specifically to this object, you have to store a NC_Command,NC_Instruction (compatible with current PP table) or list of strings describing the cycle and the points of location to apply the machining cycle.
Depending on environment, description of tool motions OR syntax of machining cycle will be generated in NC code file.
Note that linking motions can be stored between cycle location points of the CATIMfgToolPathCycle object with CATIMfgTPCycleLinkingMotion interface.

See also:
CATIMfgTPCycleLinkingMotion


Method Index


o GetCommandEvaluation(CATListValCATUnicodeString&)
Evaluates syntax relative to a NC_Command stored on the object.
o GetCycleLocationAxis(CATMathSetOfVectors&)
Retrieves axis relative to location points (Multi-axis machining).
o GetCycleLocationPoints(CATMathSetOfPoints&)
Retrieves location points coordinates.
o GetOutputMode(int&)
Retrieves output mode.
o GetUserSyntax(CATListValCATUnicodeString&)
Retrieves user syntax relative to NC_Command stored on the object.
o SetCycleLocationAxis(CATMathSetOfVectors&)
Sets axis relative to location points (Multi-axis machining).
o SetCycleLocationPoints(CATMathSetOfPoints&)
Sets location points coordinates.
o SetOutputMode(int)
Sets output mode.

Methods


o GetCommandEvaluation
public virtual CATBoolean GetCommandEvaluation(CATListValCATUnicodeString& oSyntax) =0
Evaluates syntax relative to a NC_Command stored on the object.
Parameters:
oSyntax
The value of syntax
Returns:
The return code
Legal values:
  • TRUE : NC_command found and correctly evaluated.
  • FALSE: No NC_command found.
o GetCycleLocationAxis
public virtual CATBoolean GetCycleLocationAxis(CATMathSetOfVectors& oLocationAxis) =0
Retrieves axis relative to location points (Multi-axis machining).
Parameters:
oLocationAxis
The coordinates of axis relative to location points
Returns:
The return code
Legal values:
  • TRUE : Axis relative to location points found.
  • FALSE: No axis found.
o GetCycleLocationPoints
public virtual CATBoolean GetCycleLocationPoints(CATMathSetOfPoints& oLocationPoints) =0
Retrieves location points coordinates.
Parameters:
oLocationPoints
The location points coordinates The return code
Legal values:
  • TRUE : Location points found.
  • FALSE: No location points found.
o GetOutputMode
public virtual CATBoolean GetOutputMode(int& oOutputMode) =0
Retrieves output mode.
Parameters:
oOutputMode
The output mode
Legal values:
  • 0 (default) : undefined (will be determined later, during generation of NC code, from attributes of operation).
  • 1 : tools motions, children of the object, are generated in NC code.
  • 2 : syntax of NC Command or user syntax stored on the object has to be generated in NC code
o GetUserSyntax
public virtual CATBoolean GetUserSyntax(CATListValCATUnicodeString& oUserSyntax) = 0
Retrieves user syntax relative to NC_Command stored on the object.
Parameters:
oUserSyntax
The value of user syntax
Returns:
The return code
Legal values:
  • TRUE : User syntax found.
  • FALSE: No user syntax found.
o SetCycleLocationAxis
public virtual CATBoolean SetCycleLocationAxis(CATMathSetOfVectors& iLocationAxis) =0
Sets axis relative to location points (Multi-axis machining).
Parameters:
iLocationAxis
The coordinates of axis relative to location points
o SetCycleLocationPoints
public virtual CATBoolean SetCycleLocationPoints(CATMathSetOfPoints& iLocationPoints) =0
Sets location points coordinates.
Parameters:
iLocationPoints
The location points coordinates
o SetOutputMode
public virtual CATBoolean SetOutputMode( const int iOutputMode=0) =0
Sets output mode.
Parameters:
iOutputMode
The output mode
Legal values:
  • 0 (default) : undefined (will be determined later, during generation of NC code, from attributes of operation).
  • 1 : tools motions, children of the object, are generated in NC code.
  • 2 : syntax of NC Command or user syntax stored on the object has to be generated in NC code

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

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