All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgCompoundTraject

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

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


interface CATIMfgCompoundTraject

Interface for management of tool path object.

The object linked to the manufacturing operation (activity) to model the tool path is a CATIMfgCompoundTraject object .
It can have children of several types : other CATIMfgCompoundTraject objects, CATIMfgToolPathCycle objects to model cycles for drilling and lathe operations, CATIMfgToolPathMotionCommand objects to model rotations and CATIMfgTPMultipleMotion objects to model tool motions.
The interface to manage children of a CATIMfgCompoundTraject object is CATIMfgToolPathComponents.
A CATIMfgCompoundTraject object owns reference values (linear feedrates, spindle feedrate, tool axis, ...).

See also:
CATIMfgToolPathFactory
See also:
CATIMfgToolPathComponents
See also:
CATIMfgToolPathMotionCommand
See also:
CATIMfgToolPathCycle
See also:
CATIMfgTPMultipleMotion


Method Index


o CheckToolPath()
Checks the consistency of tool path.
o GetAllElementaryTrajects(CATListValCATBaseUnknown_var&)
Retrieves tool motions objects linked to the tool path .
o GetCompensationMode(CATIMfgCompoundTraject::CompensationMode&)
Retrieves the mode of compensation.
o GetCorrectorNumber(int&)
Retrieves the current corrector number for the tool on the tool path.
o GetEditionStatus(CATBoolean&)
Indicates if a point of the tool path has been edited.
o GetEndPoint(CATMathPoint&,CATMathVector&)
Retrieves end tip point and end tool axis of the tool path.
o GetFeedrate(CATUnicodeString&,CATIMfgToolPathFeedrate_var&)
Retrieves reference feedrate of a given type on the tool path.
o GetMachiningTolerance(double&)
Retrieves the value of machining tolerance.
o GetSpindle(CATIMfgToolPathSpindle_var&)
Retrieves reference spindle on the tool path.
o GetStartPoint(CATMathPoint&,CATMathVector&)
Retrieves start tip point and start tool axis of the tool path.
o GetToolAssembly(CATIMfgToolPathToolAssembly_var&)
Retrieves tool assembly on the tool path.
o GetToolAxis(CATIMfgToolPathToolAxis_var&)
Retrieves reference tool axis of tool path.
o Init(CATBaseUnknown_var&)
Initializes parameters of tool path from the manufacturing operation.
o LoadsPPTable(CATBaseUnknown_var&)
Loads PP Table.
o SetCorrectorNumber(int)
Sets the current corrector number for the tool on the tool path.
o SetFeedrate(CATUnicodeString&,CATIMfgToolPathFeedrate_var&)
Sets reference feedrate of a given type on the tool path.
o SetSpindle(CATIMfgToolPathSpindle_var&)
Sets reference spindle on the tool path.
o SetToolAssembly(CATIMfgToolPathToolAssembly_var&)
Sets tool assembly or tool on the tool path.
o SetToolAxis(CATIMfgToolPathToolAxis_var&)
Sets reference tool axis of tool path.
o UnsetCorrectorNumber()
Unsets value of current corrector number for the tool on the tool path.
o UnsetFeedrate(CATUnicodeString&)
Unsets reference feedrate of a given type on the tool path.
o UnsetSpindle()
Unsets reference spindle on the tool path.
o UnsetToolAssembly()
Unsets tool assembly on the tool path.
o UnsetToolAxis()
Unsets reference tool axis of tool path.

Enumerated Type Index


o CompensationMode
Mode of compensation used on the tool path.

Methods


o CheckToolPath
public virtual HRESULT CheckToolPath()=0
Checks the consistency of tool path.
o GetAllElementaryTrajects
public virtual CATBoolean GetAllElementaryTrajects(CATListValCATBaseUnknown_var& oList) =0
Retrieves tool motions objects linked to the tool path .
Parameters:
oList
The list of objects (only
CATIMfgTPMultipleMotion elements)
o GetCompensationMode
public virtual CATBoolean GetCompensationMode(CATIMfgCompoundTraject::CompensationMode& oCompensationMode) =0
Retrieves the mode of compensation.
Parameters:
oCompensationMode
The mode of compensation
o GetCorrectorNumber
public virtual CATBoolean GetCorrectorNumber(int& CorrectorNumber) =0
Retrieves the current corrector number for the tool on the tool path.
Parameters:
oCorrectorNumber
The tool corrector number
o GetEditionStatus
public virtual CATBoolean GetEditionStatus(CATBoolean& oEditionStatus) =0
Indicates if a point of the tool path has been edited.
Parameters:
oEditionStatus
The mode of compensation
Legal values:
  • TRUE : at least one point has been removed, modified or inserted
  • FALSE : no point removed, modified or inserted
o GetEndPoint
public virtual CATBoolean GetEndPoint(CATMathPoint& oTipPoint,
CATMathVector& oToolAxis) =0
Retrieves end tip point and end tool axis of the tool path.
Parameters:
oTipPoint
The end tip point
oToolAxis
The end tool axis
o GetFeedrate
public virtual CATBoolean GetFeedrate(CATUnicodeString& iFeedrateString,
CATIMfgToolPathFeedrate_var& oFeedrateValue) =0
Retrieves reference feedrate of a given type on the tool path.
Parameters:
iFeedrateType
The feedrate type (see CATMfgToolPathDefs.h for legal values)
oFeedrateValue
The feedrate value
o GetMachiningTolerance
public virtual CATBoolean GetMachiningTolerance(double& oMachiningTolerance) =0
Retrieves the value of machining tolerance.
Parameters:
oMachiningTolerance
The value of machining tolerance
o GetSpindle
public virtual CATBoolean GetSpindle(CATIMfgToolPathSpindle_var& oSpindle) =0
Retrieves reference spindle on the tool path.
Parameters:
oSpindle
The reference spindle value
o GetStartPoint
public virtual CATBoolean GetStartPoint(CATMathPoint& oTipPoint,
CATMathVector& oToolAxis) =0
Retrieves start tip point and start tool axis of the tool path.
Parameters:
oTipPoint
The start tip point
oToolAxis
The start tool axis
o GetToolAssembly
public virtual CATBoolean GetToolAssembly(CATIMfgToolPathToolAssembly_var& oToolAssembly) =0
Retrieves tool assembly on the tool path.
Parameters:
oToolAssembly
The tool assembly
o GetToolAxis
public virtual CATBoolean GetToolAxis(CATIMfgToolPathToolAxis_var& oToolAxis) =0
Retrieves reference tool axis of tool path.
Parameters:
oToolAxis
The reference tool axis
o Init
public virtual CATBoolean Init(CATBaseUnknown_var& iOperation) =0
Initializes parameters of tool path from the manufacturing operation.
Parameters:
iOperation
The manufacturing operation
o LoadsPPTable
public virtual CATBoolean LoadsPPTable( const CATBaseUnknown_var& iActivity) =0
Loads PP Table.
Mandatory for evaluation of syntax relative to NC_Command stored on the CATIMfgCompoundTraject object or one of its children.
Parameters:
iActivity
The operation which is linked to the tool path
o SetCorrectorNumber
public virtual CATBoolean SetCorrectorNumber( const int CorrectorNumber) =0
Sets the current corrector number for the tool on the tool path.
Note that value of corrector number can be stored on CATIMfgCompoundTraject object from the current activity with "Init" method.
Parameters:
iCorrectorNumber
The tool corrector number
o SetFeedrate
public virtual CATBoolean SetFeedrate( const CATUnicodeString& iFeedrateType,
CATIMfgToolPathFeedrate_var& iFeedrateValue) =0
Sets reference feedrate of a given type on the tool path.
Note that all values of feedrate can be stored on CATIMfgCompoundTraject object from the current activity with "Init" method.
Parameters:
iFeedrateType
The feedrate type (see CATMfgToolPathDefs.h for legal values)
iFeedrateValue
The feedrate value
o SetSpindle
public virtual CATBoolean SetSpindle(CATIMfgToolPathSpindle_var& iSpindle) =0
Sets reference spindle on the tool path.
Note that value of spindle can be stored on CATIMfgCompoundTraject object from the current activity with "Init" method.
Parameters:
iSpindle
The reference spindle value
o SetToolAssembly
public virtual CATBoolean SetToolAssembly(CATIMfgToolPathToolAssembly_var& iToolAssembly) =0
Sets tool assembly or tool on the tool path.
Note that value of tool assembly or tool can be stored on CATIMfgCompoundTraject object from the current activity with "Init" method.
Parameters:
iToolAssembly
The tool assembly.
o SetToolAxis
public virtual CATBoolean SetToolAxis(CATIMfgToolPathToolAxis_var& iToolAxis) =0
Sets reference tool axis of tool path.
Parameters:
iToolAxis
The reference tool axis
o UnsetCorrectorNumber
public virtual CATBoolean UnsetCorrectorNumber()=0
Unsets value of current corrector number for the tool on the tool path.
o UnsetFeedrate
public virtual CATBoolean UnsetFeedrate( const CATUnicodeString& iString) =0
Unsets reference feedrate of a given type on the tool path.
Parameters:
iFeedrateType
The feedrate type (see CATMfgToolPathDefs.h for legal values)
o UnsetSpindle
public virtual CATBoolean UnsetSpindle()=0
Unsets reference spindle on the tool path.
o UnsetToolAssembly
public virtual CATBoolean UnsetToolAssembly()=0
Unsets tool assembly on the tool path.
o UnsetToolAxis
public virtual CATBoolean UnsetToolAxis()=0
Unsets reference tool axis of tool path.

Enumerated Types


o CompensationMode
enum CompensationMode {
  None_Compensation,
  PlanarTip_Compensation,
  PlanarProfile_Compensation,
  NormDSVector_Compensation,
  NormDSDirection_Compensation,
  NormPSTip_Compensation,
  NormPSContact_Compensation
}
Mode of compensation used on the tool path.
Legal values:
  • None_Compensation : no compensation
  • PlanarTip_Compensation : Cutcom compensation on tip point
  • PlanarProfile_Compensation : Cutcom compensation on profile point
  • NormDSVector_Compensation : Compensation with PQR vector (non normalized)
  • NormDSDirection_Compensation : Compensation with PQR vector (normalized)
  • NormPSTip_Compensation : Compensation on tip point and contact data
  • NormPSContact_Compensation : Compensation on contact data only

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

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