All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgTPCycleLinkingMotion

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

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


interface CATIMfgTPCycleLinkingMotion

Interface to manage linking motions between cycle location points.
This interface is available on CATIMfgToolPathCycle object.
A linking motion has an index which is the number of relative cycle location point.
The linking motion index 'i' describes the linking traject between the cycle location point index 'i' and the cycle location point index 'i+1'.
The linking motion index '0' describes the approach traject to the first cycle location point.
The linking motion index 'N' with 'N' equal to the last cycle location point number is the retract traject from the last location point.
A linking motion can be composed of several 'polylines' (linear motions), 'circle arcs' (circular motions) and syntaxes.
If the linking motion index 'i' exists, it means that, in APT file, current CYCLE/ statement has to be stopped on cycle location point index 'i', that the linking motion has to be generated (with GOTO/,... statements) and a new CYCLE/ statement has to be generated on cycle location point index 'i+1'.

See also:
CATIMfgToolPathCycle


Method Index


o AddACircleArcSubMotion(int,CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double)
Adds a sub-motion describing a "Circle Arc" (circular motion).
o AddAPPCommandSubMotion(int,CATUnicodeString&,int)
Adds a sub-motion describing a "PP command".
o AddAPolylineSubMotion(int,CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&)
Adds a sub-motion describing a "Polyline" (set of linear motions).
o AddAUserSyntaxSubMotion(int,CATUnicodeString&)
Adds a sub-motion describing a "user syntax".
o AddToolAxisInSubMotion(CATListOfDouble&,CATListOfDouble&,CATListOfDouble&)
Adds tool axis on each point for a "Polyline" or a "Circle arc" for 5 Axis machining.
o AreThereLinkingMotions()
Retrieves if at least a location point owns linking sub-motions.
o GetCircleArcCharacteristics(int,int,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double&)
Retrieves the characteristics of a "circle arc" sub-motion.
o GetCommandEvaluation(int,int,CATListValCATUnicodeString&)
Evaluates syntax relative to a "PP command" sub-motion.
o GetNumberOfSubMotions(int,int&)
Retrieves the number of linking sub-motions for a location point.
o GetPPCommandCharacteristics(int,int,CATUnicodeString&,int&)
Retrieves the characteristics of a "PP command" sub-motion.
o GetPolylineCharacteristics(int,int,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&)
Retrieves the characteristics of a "polyline" sub-motion.
o GetSpecificFeedrate(int,int,CATIMfgToolPathFeedrate_var&)
Retrieves the local feedrate stored on a sub-motion.
o GetSubMotionType(int,int,int&)
Retrieves the type of a sub-motion.
o GetSymbolicFeedrate(int,int,CATUnicodeString&,double&)
Retrieves the feedrate stored on a sub-motion.
o GetToolAxis(int,int,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&)
Retrieves the tool axis stored on a sub-motion.
o GetUserSyntaxCharacteristics(int,int,CATUnicodeString&)
Retrieves the characteristics of a "User syntax" sub-motion.
o SetRatioOnFeedrate(int,int,double)
Sets a ratio on the feedrate of a sub-motion.
o SetSpecificFeedrate(int,int,CATIMfgToolPathFeedrate_var&)
Sets a local feedrate on a sub-motion.
o SetSymbolicFeedrate(int,int,CATUnicodeString&)
Sets a symbolic feedrate on a sub-motion.

Enumerated Type Index


o SubMotionType
The type of sub-motion.

Methods


o AddACircleArcSubMotion
public virtual CATBoolean AddACircleArcSubMotion(int iLocationPoint,
const CATUnicodeString& iTrajectType,
const CATUnicodeString& iFeedrateType,
const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ,
const CATMathVector& iNormal,
const CATMathPoint& iCenter,
double iRadius) = 0
Adds a sub-motion describing a "Circle Arc" (circular motion).
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iTrajectType
The type of traject
Legal values:
  • "TPApproachTraject" : approach traject
  • "TPMachiningTraject" : machining traject
  • "TPRetractTraject" : retract traject
  • "TPLinkingTraject" : linking traject
  • "TPBetweenPathTraject" : traject between path
iFeedrateType
The type of feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate
iX,iY,iZ
The coordinates of tip points (discretization of the circle arc)
iNormal
The oriented normal to the plane containing the circle arc
iCenter
The center of the circle arc
iRadius
The radius of the circle arc.
o AddAPPCommandSubMotion
public virtual CATBoolean AddAPPCommandSubMotion(int iLocationPoint,
const CATUnicodeString& iPPCommand,
int iSequenceNumber= 1) = 0
Adds a sub-motion describing a "PP command". A PP Syntax is a "NC Command" described in PP Table and evaluated from it during generation of APT file.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iPPCommand
The name of "NC Command"
iSequenceNumber
The number of sequence in the PP Table
o AddAPolylineSubMotion
public virtual CATBoolean AddAPolylineSubMotion(int iLocationPoint,
const CATUnicodeString& iTrajectType,
const CATUnicodeString& iFeedrateType,
const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ) = 0
Adds a sub-motion describing a "Polyline" (set of linear motions).
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iTrajectType
The type of traject
Legal values:
  • "TPApproachTraject" : approach traject
  • "TPMachiningTraject" : machining traject
  • "TPRetractTraject" : retract traject
  • "TPLinkingTraject" : linking traject
  • "TPBetweenPathTraject" : traject between path
iFeedrateType
The type of feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate
iX,iY,iZ
The coordinates of tip points
o AddAUserSyntaxSubMotion
public virtual CATBoolean AddAUserSyntaxSubMotion(int iLocationPoint,
const CATUnicodeString& iUserSyntax) = 0
Adds a sub-motion describing a "user syntax". A user syntax is a string generated as it is in APT file.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iUserSyntax
The user syntax
o AddToolAxisInSubMotion
public virtual CATBoolean AddToolAxisInSubMotion( const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ) = 0
Adds tool axis on each point for a "Polyline" or a "Circle arc" for 5 Axis machining. This method should be called just after "AddAPolylineSubMotion" or "AddACircleArcSubMotion" in 5 Axis Machining.
Parameters:
iX,iY,iZ
The tool axis values
o AreThereLinkingMotions
public virtual int AreThereLinkingMotions()= 0
Retrieves if at least a location point owns linking sub-motions.
Returns:
The return code
Legal values:
  • 0 : no location point owns linking sub-motions
  • >0 : at least one location point owns one or several linking sub-motions
o GetCircleArcCharacteristics
public virtual CATBoolean GetCircleArcCharacteristics(int iLocationPoint,
int iSubMotion,
CATUnicodeString& oTrajectType,
CATListOfDouble& oX,
CATListOfDouble& oY,
CATListOfDouble& oZ,
CATMathVector& oNormal,
CATMathPoint& oCenter,
double& oRadius) = 0
Retrieves the characteristics of a "circle arc" sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "circle arc" one)
oTrajectType
The type of traject
Legal values:
  • "TPApproachTraject" : approach traject
  • "TPMachiningTraject" : machining traject
  • "TPRetractTraject" : retract traject
  • "TPLinkingTraject" : linking traject
  • "TPBetweenPathTraject" : traject between path
oFeedrateType
The type of feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate
oX,oY,oZ
The coordinates of tip points
oNormal
The oriented normal to the plane containing the circle arc
oCenter
The center of the circle arc
oRadius
The radius of the circle arc.
o GetCommandEvaluation
public virtual CATBoolean GetCommandEvaluation(int iLocationPoint,
int iSubMotion,
CATListValCATUnicodeString& oSyntax) =0
Evaluates syntax relative to a "PP command" sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "PP command" one)
oSyntax
The value of syntax
o GetNumberOfSubMotions
public virtual CATBoolean GetNumberOfSubMotions(int iLocationPoint,
int& oNumberOfMotions) = 0
Retrieves the number of linking sub-motions for a location point.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
oNumberOfMotions
The number of linking sub-motions
o GetPPCommandCharacteristics
public virtual CATBoolean GetPPCommandCharacteristics(int iLocationPoint,
int iSubMotion,
CATUnicodeString& oPPCommand,
int& oSequenceNumber) = 0
Retrieves the characteristics of a "PP command" sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "PP command" one)
oPPCommand
The name of "NC Command"
oSequenceNumber
The number of sequence in the PP Table
o GetPolylineCharacteristics
public virtual CATBoolean GetPolylineCharacteristics(int iLocationPoint,
int iSubMotion,
CATUnicodeString& oTrajectType,
CATListOfDouble& oX,
CATListOfDouble& oY,
CATListOfDouble& oZ) = 0
Retrieves the characteristics of a "polyline" sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "polyline" one)
oTrajectType
The type of traject
Legal values:
  • "TPApproachTraject" : approach traject
  • "TPMachiningTraject" : machining traject
  • "TPRetractTraject" : retract traject
  • "TPLinkingTraject" : linking traject
  • "TPBetweenPathTraject" : traject between path
oFeedrateType
The type of feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate
oX,oY,oZ
The coordinates of tip points
o GetSpecificFeedrate
public virtual CATBoolean GetSpecificFeedrate(int iLocationPoint,
int iSubMotion,
CATIMfgToolPathFeedrate_var& oFeedrate) =0
Retrieves the local feedrate stored on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must be a local one.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The number of sub-motion
oFeedrate
The feedrate
Returns:
The return code
Legal values:
  • FALSE : the feedrate is a not a local one (use "GetSymbolicFeedrate" method)
o GetSubMotionType
public virtual CATBoolean GetSubMotionType(int iLocationPoint,
int iSubMotion,
int& oMotionType) = 0
Retrieves the type of a sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion
oMotionType
The type of sub-motion
o GetSymbolicFeedrate
public virtual CATBoolean GetSymbolicFeedrate(int iLocationPoint,
int iSubMotion,
CATUnicodeString& oFeedrate,
double& oRatio) =0
Retrieves the feedrate stored on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must not be a local one.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The number of sub-motion
oFeedrate
The feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate
oRatio
The ratio value
Returns:
The return code
Legal values:
  • FALSE : the feedrate is a local one (use "GetSpecificFeedrate" method)
o GetToolAxis
public virtual CATBoolean GetToolAxis(int iLocationPoint,
int iSubMotion,
CATListOfDouble& oX,
CATListOfDouble& oY,
CATListOfDouble& oZ) = 0
Retrieves the tool axis stored on a sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "polyline" or a "circle" one)
oX,oY,oZ
The tool axis values
Returns:
The return code
Legal values:
  • FALSE : no tool axis stored for the sub-motion
o GetUserSyntaxCharacteristics
public virtual CATBoolean GetUserSyntaxCharacteristics(int iLocationPoint,
int iSubMotion,
CATUnicodeString& oUserSyntax) = 0
Retrieves the characteristics of a "User syntax" sub-motion.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The index of sub-motion (must be a "user syntax" one)
oUserSyntax
The user syntax
o SetRatioOnFeedrate
public virtual CATBoolean SetRatioOnFeedrate(int iLocationPoint,
int iSubMotion,
double iRatio) =0
Sets a ratio on the feedrate of a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must be a symbolic one.
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The number of sub-motion
iRatio
The ratio to apply to the symbolic feedrate
o SetSpecificFeedrate
public virtual CATBoolean SetSpecificFeedrate(int iLocationPoint,
int iSubMotion,
CATIMfgToolPathFeedrate_var& iFeedrate) =0
Sets a local feedrate on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc".
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The number of sub-motion
iFeedrate
The local feedrate
o SetSymbolicFeedrate
public virtual CATBoolean SetSymbolicFeedrate(int iLocationPoint,
int iSubMotion,
const CATUnicodeString& iFeedrateType) =0
Sets a symbolic feedrate on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc".
Parameters:
iLocationPoint
The index of location point
Legal values:
  • 0 : approach traject to the first location point
  • last location point index : retract traject from the last location point
  • i : linking traject from the location point index i to the location point index i+1
iSubMotion
The number of sub-motion
iFeedrateType
The type of feedrate
Legal values:
  • "TPApproachFeedrate" : approach feedrate
  • "TPMachiningFeedrate": machining feedrate
  • "TPRetractFeedrate" : retract feedrate
  • "TPRapidFeedrate" : rapid feedrate
  • "TPFinishingFeedrate" : finishing feedrate
  • "TPChamferingFeedrate" : chamfering feedrate
  • "TPPlungeFeedrate" : plunge feedrate

Enumerated Types


o SubMotionType
enum SubMotionType {
  PolyLine,
  Circle,
  PPCommand,
  UserSyntax
}
The type of sub-motion.
Legal values:
  • Polyline : sub-motion describing a "polyline" (Set of linear motions)
  • Circle : sub-motion describing a "circle arc" (circular motion)
  • PPCommand : sub-motion describing a "PP command"
  • UserSyntax : sub-motion describing a "user syntax"

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

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