All Frameworks  Class Hierarchy  This Framework  Indexes   

ManufacturingInterfaces Interface 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 GetEndPPCommandEvaluation(CATListValCATUnicodeString&)
Evaluates syntax relative to a End NC_Command stored on the object.
o GetEndPPCommand(CATIMfgPPCommand_var&)
Retrieves the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
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 SetEndPPCommand(CATUnicodeString&)
Create and Set the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
o SetEndPPCommand(CATIMfgPPCommand_var&)
Set the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
o SetOutputMode(int)
Sets output mode.

Methods


o GetCommandEvaluation
public virtual GetCommandEvaluation( oSyntax)
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 GetCycleLocationAxis( oLocationAxis)
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 GetCycleLocationPoints( oLocationPoints)
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 GetEndPPCommandEvaluation
public virtual GetEndPPCommandEvaluation( oSyntax)
Evaluates syntax relative to a End 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 GetEndPPCommand
public virtual GetEndPPCommand( oPPCommand)
Retrieves the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
Parameters:
oPPCommand
The PPCommand
o GetOutputMode
public virtual GetOutputMode( oOutputMode)
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 GetUserSyntax( oUserSyntax)
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 SetCycleLocationAxis( iLocationAxis)
Sets axis relative to location points (Multi-axis machining).
Parameters:
iLocationAxis
The coordinates of axis relative to location points
o SetCycleLocationPoints
public virtual SetCycleLocationPoints( iLocationPoints)
Sets location points coordinates.
Parameters:
iLocationPoints
The location points coordinates
o SetEndPPCommand
public virtual SetEndPPCommand( const iPPCommandName)
Create and Set the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
Parameters:
iPPCommandName
The name of the PPCommand
o SetEndPPCommand
public virtual SetEndPPCommand( const iPPCommand)
Set the End PPCommand of the Cycle (NC_CYCLE_OFF by default)
Parameters:
iPPCommand
The PPCommand
o SetOutputMode
public virtual SetOutputMode( const iOutputMode=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.