All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgActivityMacroMotion

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

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


interface CATIMfgActivityMacroMotion

Interface dedicated to manage the approach, retract, and clerance groups of path of a macro.
Role: This interface offers services to access elementary macro motion and clearance general datas


Method Index


o DeleteElementaryMotion(CATBaseUnknown_var&,int)
Deletes an elementary motion in the macro motion.
o DeleteElementaryMotion(int,int)
Deletes an elementary motion in the macro motion.
o GetClearanceDistance(double&)
Returns clearance distance if clearance mode=Distance.
o GetClearanceMode(int&)
Read the type of Clearance.
o GetClearancePlane(CATMathPlane&)
Returns clearance plane if clearance mode=To a Plane.
o GetElementaryMotion(int,CATBaseUnknown_var&)
Access to an elementary macro motion .
o GetNumberOfElementaryMotions(int&)
Returns the number of macro motions of a group (approach, retract, clearance (= 3 in this case)).
o InsertElementaryMotion(int,CATBaseUnknown_var&,int)
Inserts an elementary motion in the macro motion.
o InsertElementaryMotion(int,CATUnicodeString&,int)
Inserts an elementary motion in the macro motion.
o IsComplete(int&,int&)
Returns if a macromotion is complete or not on an operation.

Methods


o DeleteElementaryMotion
public virtual HRESULT DeleteElementaryMotion(CATBaseUnknown_var& iMotion,
int iNotify= 1)=0
Deletes an elementary motion in the macro motion.
Parameters:
iMotion
The motion to delete
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o DeleteElementaryMotion
public virtual HRESULT DeleteElementaryMotion(int iPosition,
int iNotify= 1)=0
Deletes an elementary motion in the macro motion.
Parameters:
iPosition
The position of the motion to delete in the aggregate
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o GetClearanceDistance
public virtual HRESULT GetClearanceDistance(double& oDistance)=0
Returns clearance distance if clearance mode=Distance.
o GetClearanceMode
public virtual HRESULT GetClearanceMode(int& oMode)=0
Read the type of Clearance.
Parameters:
oMode
  • 1:Distance (or Optimized in clearance of 3-axis operations)
  • 2:To a plane (or Perpendicular to safety plane in clearance of 3-axis operations)
  • 3:To safety plane
  • 4:Along tool axis in clearance of 3-axis operations
o GetClearancePlane
public virtual HRESULT GetClearancePlane(CATMathPlane& oPlane)=0
Returns clearance plane if clearance mode=To a Plane.
o GetElementaryMotion
public virtual HRESULT GetElementaryMotion( const int iPosition,
CATBaseUnknown_var& oMacroMotion)=0
Access to an elementary macro motion .
o GetNumberOfElementaryMotions
public virtual HRESULT GetNumberOfElementaryMotions(int& oNumber)=0
Returns the number of macro motions of a group (approach, retract, clearance (= 3 in this case)).
o InsertElementaryMotion
public virtual HRESULT InsertElementaryMotion(int iPosition,
CATBaseUnknown_var& iMotion,
int iNotify= 1)=0
Inserts an elementary motion in the macro motion.
Parameters:
iPosition
The position in the aggregate
iMotion
The motion to add
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o InsertElementaryMotion
public virtual HRESULT InsertElementaryMotion(int iPosition,
CATUnicodeString& iMotionType,
int iNotify= 1)=0
Inserts an elementary motion in the macro motion.
Parameters:
iPosition
The position in the aggregate
iMotionType
Type of the motion to add
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o IsComplete
public virtual HRESULT IsComplete( const int& iSfyPlane,
int& oComplete)=0
Returns if a macromotion is complete or not on an operation.
Parameters:
iSfyPlane
  • 0:no safety plane
  • 1: safety plane defined
oComplete
  • 0:not complete
  • 1:complete

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

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