All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgTPSynchro

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

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


interface CATIMfgTPSynchro

Interface on the tool path to give an index value to each entity of the tool path.

Depending on options, each index value can indicate a linear motion, a circular motion or a CATIMfgToolPathCycle object to describe a machining cycle.


Method Index


o AddCircleArcInLastMultipleMotion(CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double,CATListOfInt&)
Add a subtraject describing a "Circle Arc" (circular motion) in the last MfgMultipleMotion object of the tool path.
o AddHelixInLastMultipleMotion(CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double,CATMathVector&,double,CATListOfInt&)
Add a subtraject describing a "Helix" (helical motion) in the last MfgMultipleMotion object of the tool path.
o AddPPCommandInLastMultipleMotion(CATUnicodeString&,int,CATListOfInt&)
Adds a subtraject describing a "PP command" in the last MfgMultipleMotion object of the tool path.
o AddPolylineInLastMultipleMotion(CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATListOfInt&)
Adds a subtraject describing a "Polyline" (set of linear motions) in the last MfgMultipleMotion object of the tool path.
o AddUserSyntaxInLastMultipleMotion(CATUnicodeString&,CATListOfInt&)
Adds a subtraject describing a "user syntax" in the last MfgMultipleMotion object of the tool path.
o CloseSynchroSession()
Closes the working session.
o GetIndexFromToolPathData(CATBaseUnknown_var&,int,int,int&)
Retrieves an index value from data on the tool path.
o GetNumberOfMotions(int&)
Returns the total number of index values.
o GetToolPathDataFromIndex(int,CATBaseUnknown_var&,int&,int&)
Retrieves data on the tool path from an index value.
o OpenSynchroSession()
Opens the working session.
o SetCircleMode(CATIMfgTPSynchro::CircleMode&)
Sets the management mode for circle.
o SetCycleMode(CATIMfgTPSynchro::CycleMode&)
Sets the management mode for cycle.
o SetHelixMode(CATIMfgTPSynchro::HelixMode&)
Sets the management mode for helical.

Enumerated Type Index


o CircleMode
Mode of management for circle.
o CycleMode
Mode of management for cycle.
o HelixMode
Mode of management for helical.

Methods


o AddCircleArcInLastMultipleMotion
public virtual HRESULT AddCircleArcInLastMultipleMotion( const CATUnicodeString& iTrajectType,
const CATUnicodeString& iFeedrateType,
const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ,
const CATMathVector& iNormal,
const CATMathPoint& iCenter,
double iRadius,
CATListOfInt& oIndex) = 0
Add a subtraject describing a "Circle Arc" (circular motion) in the last MfgMultipleMotion object of the tool path.
Parameters:
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)
iNormale
The oriented normal to the plane containing the circle arc
iCenter
The center of the circle arc
iRadius
The radius of the circle arc
oIndex
The list of index values (depending on management mode for circle, an index value for each point of discretization of the circle or only one index value for the circle)
o AddHelixInLastMultipleMotion
public virtual HRESULT AddHelixInLastMultipleMotion( const CATUnicodeString& iTrajectType,
const CATUnicodeString& iFeedrateType,
const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ,
const CATMathVector& iAxis,
const CATMathPoint& iCenter,
double iRadius,
const CATMathVector& iStartTangent,
double iPitch,
CATListOfInt& oIndex) = 0
Add a subtraject describing a "Helix" (helical motion) in the last MfgMultipleMotion object of the tool path.
Parameters:
iTrajectType
The type of traject
Legal values:
  • "TPApproachTraject" : approach traject
  • "TPMachiningTraject" : machining traject
  • "TPRetractTraject" : retract traject
  • "TPLinkingTraject" : linking traject
  • "TPBetweenPathTraject" : traject between path
  • "TPApproachTrajectAlongSection" : approach traject along section< /li>
  • "TPLinkingTrajectAlongSection" : linking traject along section
  • "TPRetractTrajectAlongSection" : retract traject along section
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
  • "TPAirCuttingFeedrate" : air cutting feedrate
iX
The X coordinate of tip points (discretization of the helix)
iY
The Y coordinate of tip points (discretization of the helix)
iZ
The Z coordinates of tip points (discretization of the helix)
iAxis
The oriented axis of the helix
iCenter
The center of the helix
iRadius
The radius of the helix
iStartTangent
The oriented tangent to the helix at the start point
iPitch
The pitch of the helix
oIndex
The list of index values (depending on management mode for helix, an index value for each point of discretization of the helix or only one index value for the helix)
o AddPPCommandInLastMultipleMotion
public virtual HRESULT AddPPCommandInLastMultipleMotion( const CATUnicodeString& iPPCommand,
int iSequenceNumber,
CATListOfInt& oIndex) = 0
Adds a subtraject describing a "PP command" in the last MfgMultipleMotion object of the tool path.
A PP Syntax is a "NC Command" described in PP Table and evaluated from it during generation of APT file.
Parameters:
iPPCommand
The name of "NC Command"
iSequenceNumber
The number of sequence in the PP Table
oIndex
The list of index values (one value for the "PP command")
o AddPolylineInLastMultipleMotion
public virtual HRESULT AddPolylineInLastMultipleMotion( const CATUnicodeString& iTrajectType,
const CATUnicodeString& iFeedrateType,
const CATListOfDouble& iX,
const CATListOfDouble& iY,
const CATListOfDouble& iZ,
CATListOfInt& oIndex) = 0
Adds a subtraject describing a "Polyline" (set of linear motions) in the last MfgMultipleMotion object of the tool path.
Parameters:
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
oIndex
The list of index values (an index value for each tip point)
o AddUserSyntaxInLastMultipleMotion
public virtual HRESULT AddUserSyntaxInLastMultipleMotion( const CATUnicodeString& iUserSyntax,
CATListOfInt& oIndex) = 0
Adds a subtraject describing a "user syntax" in the last MfgMultipleMotion object of the tool path.
A user syntax is a string generated as it is in APT file.
Parameters:
iUserSyntax
The user syntax
oIndex
The list of index values (one value for the "user syntax")
o CloseSynchroSession
public virtual HRESULT CloseSynchroSession()= 0
Closes the working session.
Last method to call when using this interface.
o GetIndexFromToolPathData
public virtual HRESULT GetIndexFromToolPathData( const CATBaseUnknown_var& ispToolPathData,
int iTipPointRank,
int iSubTrajectRank,
int& oIndex) = 0
Retrieves an index value from data on the tool path.
Parameters:
ispToolPathData
The interface on the tool path objet (see
CATIMfgTPMultipleMotion, CATIMfgTPMultipleMotionWithProfileData, CATIMfgToolPathCycle )
iTipPointRank
The number of tip point (in case of a linear motion on an
CATIMfgTPMultipleMotion object)
iSubTrajectRank
The number of sub-motion (in case of an
CATIMfgTPMultipleMotion object)
oIndex
The value of index
o GetNumberOfMotions
public virtual HRESULT GetNumberOfMotions(int& oSubMotion) = 0
Returns the total number of index values.
Parameters:
oSubMotion
The number of index values
o GetToolPathDataFromIndex
public virtual HRESULT GetToolPathDataFromIndex(int iIndex,
CATBaseUnknown_var& ospToolPathData,
int& oTipPointRank,
int& oSubTrajectRank) = 0
Retrieves data on the tool path from an index value.
Parameters:
iIndex
The value of index
ospToolPathData
The interface on the tool path objet (see
CATIMfgTPMultipleMotion, CATIMfgTPMultipleMotionWithProfileData, CATIMfgToolPathCycle )
oTipPointRank
The number of tip point (in case of a linear motion on an
CATIMfgTPMultipleMotion object)
oSubTrajectRank
The number of sub-motion (in case of an
CATIMfgTPMultipleMotion object)
o OpenSynchroSession
public virtual HRESULT OpenSynchroSession()= 0
Opens the working session.
First method to call when using this interface.
o SetCircleMode
public virtual HRESULT SetCircleMode( const CATIMfgTPSynchro::CircleMode& iCircleMode) = 0
Sets the management mode for circle.
Parameters:
iCircleMode
The mode of management for circle
o SetCycleMode
public virtual HRESULT SetCycleMode( const CATIMfgTPSynchro::CycleMode& iCycleMode) = 0
Sets the management mode for cycle.
Parameters:
iCycleMode
The mode of management for cycle
o SetHelixMode
public virtual HRESULT SetHelixMode( const CATIMfgTPSynchro::HelixMode& iHelix) = 0
Sets the management mode for helical.
Parameters:
iHelixMode
The mode of management for helix

Enumerated Types


o CircleMode
enum CircleMode {
  Circle_OFF,
  Circle_ON
}
Mode of management for circle.

Legal values:
  • Circle_OFF : each circle is seen as a set of linear motions and each point of discretization of the circle has an index value
  • Circle_ON : only one index value for the circle
o CycleMode
enum CycleMode {
  Cycle_OFF,
  Cycle_ON
}
Mode of management for cycle.

Legal values:
o HelixMode
enum HelixMode {
  Helix_OFF,
  Helix_ON
}
Mode of management for helical.

Legal values:
  • Helix_OFF : each helix is seen as a set of linear motions and each point of discretization of the helix has an index value
  • Helix_ON : only one index value for the helix

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

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