MachiningToolPathUseItf Interface DELIMfgToolPathCycle
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELIMfgToolPathCycle
Interface for management of machining cycle inside tool path model.
Role: A DELIMfgToolPathCycle object is a specialized object.
As a
object, you can store on it reference values (feedrates,spindle,tool axis,....) and you can store the description of a tool path (using
,
,
or
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.
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 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 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 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: DELIMfgToolPathCycle.h
If needed, your Imakefile.mk should include the module: MachiningToolPathUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.