All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgActivityMacroParameters

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

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


interface CATIMfgActivityMacroParameters

Interface dedicated to manufacturing operation management with macros.
Role: This interface offers services to access macros from an operation


Method Index


o GetApproachMacroMotions(int&,CATBaseUnknown_var&)
Access to the approach motions of a macro of a given type on a operation.
o GetClearanceCornerizedRadius(double&)
Returns clearance radius if clearance is cornerized.
o GetClearanceMacroMotions(CATBaseUnknown_var&)
Access to the clearance macro motions on a operation.
o GetGlobalApproachMacroMotions(CATBaseUnknown_var&)
Access to the global approach macro motion (circular milling and thread milling).
o GetGlobalRetractMacroMotions(CATBaseUnknown_var&)
Access to the global retract macro motion (circular milling and thread milling).
o GetRetractMacroMotions(int&,CATBaseUnknown_var&)
Access to the retract motions of a macro of a given type on a operation.
o GetSafetyPlane(CATMathPlane&)
Returns setup safety plane (use if clearance mode=Safety Plane).
o IsActive(int&,int&)
Determines wether a macro type on an operation is active or not.
o IsClearanceCornerized(int&)
Determines wether the clearance on the operation is cornerized or not.
o IsComplete(int&,int&)
Returns if a macro or if all macros is/are complete or not on an operation.

Methods


o GetApproachMacroMotions
public virtual HRESULT GetApproachMacroMotions( const int& iMacroType,
CATBaseUnknown_var& oMacroMotions)=0
Access to the approach motions of a macro of a given type on a operation. Not used for Retract Macro and Clearance.
Parameters:
iMacroType

Legal values:
1:Approach
2:Retract
3:ReturnOneLevel
4:ReturnTwoLevels
5:Linking
6:ReturnFinihPath
7:Clearance
oMacroMotions
The macro motions
o GetClearanceCornerizedRadius
public virtual HRESULT GetClearanceCornerizedRadius(double& oRadius)=0
Returns clearance radius if clearance is cornerized.
o GetClearanceMacroMotions
public virtual HRESULT GetClearanceMacroMotions(CATBaseUnknown_var& oMacroMotions)=0
Access to the clearance macro motions on a operation.
o GetGlobalApproachMacroMotions
public virtual HRESULT GetGlobalApproachMacroMotions(CATBaseUnknown_var& oMacroMotions)=0
Access to the global approach macro motion (circular milling and thread milling).
o GetGlobalRetractMacroMotions
public virtual HRESULT GetGlobalRetractMacroMotions(CATBaseUnknown_var& oMacroMotions)=0
Access to the global retract macro motion (circular milling and thread milling).
o GetRetractMacroMotions
public virtual HRESULT GetRetractMacroMotions( const int& iMacroType,
CATBaseUnknown_var& oMacroMotions)=0
Access to the retract motions of a macro of a given type on a operation. Not used for Approach Macro and Clearance.
Parameters:
iMacroType

Legal values:
1:Approach
2:Retract
3:ReturnOneLevel
4:ReturnTwoLevels
5:Linking
6:ReturnFinihPath
7:Clearance
oMacroMotions
The macro motions
o GetSafetyPlane
public virtual HRESULT GetSafetyPlane(CATMathPlane& oPlane)=0
Returns setup safety plane (use if clearance mode=Safety Plane).
o IsActive
public virtual HRESULT IsActive( const int& iMacroType,
int& oActive)=0
Determines wether a macro type on an operation is active or not.
Parameters:
iMacroType

Legal values:
1:Approach
2:Retract
3:ReturnOneLevel
4:ReturnTwoLevels
5:Linking
6:ReturnFinihPath
7:Clearance
oActive
0:not active
1:Active
o IsClearanceCornerized
public virtual HRESULT IsClearanceCornerized(int& oCornerized)=0
Determines wether the clearance on the operation is cornerized or not.
Parameters:
oCornerized
  • 0:not cornerized
  • 1:cornerized
  • o IsComplete
    public virtual HRESULT IsComplete( const int& iMacroType,
    int& oComplete)=0
    Returns if a macro or if all macros is/are complete or not on an operation.
    Parameters:
    iMacroType

    Legal values:
    1:Approach
    2:Retract
    3:ReturnOneLevel
    4:ReturnTwoLevels
    5:Linking
    6:ReturnFinihPath
    7:Clearance
    oComplete
    0:not complete
    1:complete

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

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