MachiningUseItf Interface DELIMfgMachiningAxisSystem
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
 interface DELIMfgMachiningAxisSystem
    Interface dedicated to machining axis system.
 Role: This interface offers services mainly to manage the Machining Axis System object 
 Method Index
 
 -  o 
    GetAxis(CATMathAxis&)
 -   Gets the mathematical definition of the machining axis system.
 
 -  o 
    GetAxisType(CATUnicodeString&)
 -   Gets the machining axis type.
 
 -  o 
    GetIsOrigin(int&)
 -   Gets if the machining axis system is an origin.
 
 -  o 
    GetOriginGroup(int&)
 -   Gets the origin group in case of an origin usage.
 
 -  o 
    GetOriginNumber(int&)
 -   Gets the origin number in case of an origin usage.
 
 -  o 
    GetOriginPoint(CATMathPoint&)
 -   Gets the origin point of the machining axis system.
 
 -  o 
    GetPAS(DELIMfgGeometryAccess_var&)
 -   Gets the Part Axis System of the definition of the Machining Axis System.
 
 -  o 
    GetPositionGeometry(DELIMfgGeometryAccess_var&)
 -   Gets the positioning geometry of the machining axis system.
 
 -  o 
    GetUsePAS(boolean&)
 -   Retrieves if a Part Axis System is used or not in a machining axis system.
 
 -  o 
    GetXDirection(CATMathDirection&)
 -   Gets the X direction of the machining axis system.
 
 -  o 
    GetYDirection(CATMathDirection&)
 -   Gets the Y direction of the machining axis system.
 
 -  o 
    GetZDirection(CATMathDirection&)
 -   Gets the Z direction of the machining axis system.
 
 -  o 
    IsComplete()
 -   Checks if Machining Axis System is complete.
 
 -  o 
    IsOK()
 -   Checks if the MAchining Axis System definition is OK.
 
 -  o 
    IsUpToDate()
 -   Checks if Machining Axis System is up to date.
 
 -  o 
    ModifyOriginPoint(CATMathPoint&)
 -   Modifies the origin point of the machining axis system.
 
 -  o 
    Normalize()
 -   Normalizes the machining axis system.
 
 -  o 
    SetAxisType(CATUnicodeString&)
 -   Sets the machining axis type.
 
 -  o 
    SetIsOrigin(int)
 -   Sets if the machining axis system is used as an origin.
 
 -  o 
    SetOrigin(CATBaseUnknown_var&,CATBaseUnknown_var&)
 -   Sets the geometic element defining the origin of a Machining Axis System.
 
 -  o 
    SetOriginGroup(int)
 -   Sets the origin group number in case of an origin usage.
 
 -  o 
    SetOriginNumber(int)
 -   Sets the origin number in case of an origin usage.
 
 -  o 
    SetOriginPoint(CATMathPoint&)
 -   Sets the origin point of the machining axis system.
 
 -  o 
    SetPAS(CATBaseUnknown_var&,CATBaseUnknown_var&)
 -   Sets the Part Axis System defining the machining axis system.
 
 -  o 
    SetUsePAS(boolean)
 -   Sets if a Part Axis System is used or not.
 
 -  o 
    SetXDirection(CATMathDirection&)
 -   Sets the X direction of the machining axis system.
 
 -  o 
    SetZDirection(CATMathDirection&)
 -   Sets the Z direction of the machining axis system.
 
 -  o 
    UseGeometricPoint(int&)
 -   Outputs if a geometrical point is used or not.
 
 Methods
 
  o GetAxis
  |   public virtual   GetAxis( |   | oAxis)   | 
  - 
 Gets the mathematical definition of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oAxis
   
 -   The mathematical axis
 
 
 
  o GetAxisType
  |   public virtual   GetAxisType( |   | oAxisType)   | 
  - 
 Gets the machining axis type.
 
  -  Parameters:
  
 - 
    
    -  oAxisType
   
 -   The type
 
 
 
  o GetIsOrigin
  |   public virtual   GetIsOrigin( |   | oFlag)   | 
  - 
 Gets if the machining axis system is an origin.
 
  -  Parameters:
  
 - 
    
    -  oFlag
   
 -   The flag
 
 
 
  o GetOriginGroup
  |   public virtual   GetOriginGroup( |   | Flag)   | 
  - 
 Gets the origin group in case of an origin usage.
 
  -  Parameters:
  
 - 
    
    -  oString
   
 -   The mode
 
 
 
  o GetOriginNumber
  |   public virtual   GetOriginNumber( |   | oFlag)   | 
  - 
 Gets the origin number in case of an origin usage.
 
  -  Parameters:
  
 - 
    
    -  oFlag
   
 -   The origin number
 
 
 
  o GetOriginPoint
  |   public virtual   GetOriginPoint( |   | oPoint)   | 
  - 
 Gets the origin point of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oPoint
   
 -   The mathematical point
 
 
 
  o GetPAS
  |   public virtual   GetPAS( |   | oPAS)   | 
  - 
 Gets the Part Axis System of the definition of the Machining Axis System.
 
  -  Parameters:
  
 - 
    
    -  oPAS
   
 -   The part axis system
 
 
 
  o GetPositionGeometry
  |   public virtual   GetPositionGeometry( |   | oGeometry)   | 
  - 
 Gets the positioning geometry of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oGeometry
   
 -   The geometry
 
 
 
  o GetUsePAS
  |   public virtual   GetUsePAS( |   | oUsedPAS)   | 
  - 
 Retrieves if a Part Axis System is used or not in a machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oUsedPAS
   
 -   The output
 
 
 
  o GetXDirection
  |   public virtual   GetXDirection( |   | oDirection)   | 
  - 
 Gets the X direction of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oDirection
   
 -   The mathematical direction
 
 
 
  o GetYDirection
  |   public virtual   GetYDirection( |   | oDirection)   | 
  - 
 Gets the Y direction of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oDirection
   
 -   The mathematical direction
 
 
 
  o GetZDirection
  |   public virtual   GetZDirection( |   | oDirection)   | 
  - 
 Gets the Z direction of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  oDirection
   
 -   The mathematical direction
 
 
 
  o IsComplete
  |   public virtual   IsComplete( | )   | 
  - 
 Checks if Machining Axis System is complete.
 
  o IsOK
  
  - 
 Checks if the MAchining Axis System definition is OK.
 
  o IsUpToDate
  |   public virtual   IsUpToDate( | )   | 
  - 
 Checks if Machining Axis System is up to date.
 
  o ModifyOriginPoint
  |   public virtual   ModifyOriginPoint( |  const   | iPoint)   | 
  - 
 Modifies the origin point of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  iPoint
   
 -   The mathematical point
 
 
 
  o Normalize
  |   public virtual   Normalize( | )   | 
  - 
 Normalizes the machining axis system.
 
  o SetAxisType
  |   public virtual   SetAxisType( |  const   | iAxisType)   | 
  - 
 Sets the machining axis type.
 
  -  Parameters:
  
 - 
    
    -  iAxisType
   
 -   The type
 
 
 
  o SetIsOrigin
  |   public virtual   SetIsOrigin( |  const   | iFlag)   | 
  - 
 Sets if the machining axis system is used as an origin.
 
  -  Parameters:
  
 - 
    
    -  iFlag
   
 -   The flag
 
 
 
  o SetOrigin
  |   public virtual   SetOrigin( |  const   | iOrigin, | 
 |  const   | iProduct)   | 
  - 
 Sets the geometic element defining the origin of a Machining Axis System.
 
  -  Parameters:
  
 - 
    
    -  iOrigin
   
 -   The origin elemnt
 
 
    -  iProduct
   
 -   The belonging product
 
 
 
  o SetOriginGroup
  |   public virtual   SetOriginGroup( |  const   | iFlag)   | 
  - 
 Sets the origin group number in case of an origin usage.
 
  -  Parameters:
  
 - 
    
    -  iFlag
   
 -   The flag
 
 
 
  o SetOriginNumber
  |   public virtual   SetOriginNumber( |  const   | iFlag)   | 
  - 
 Sets the origin number in case of an origin usage.
 
  -  Parameters:
  
 - 
    
    -  iFlag
   
 -   The flag
 
 
 
  o SetOriginPoint
  |   public virtual   SetOriginPoint( |  const   | iPoint)   | 
  - 
 Sets the origin point of the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  iPoint
   
 -   The mathematical point
 
 
 
  o SetPAS
  |   public virtual   SetPAS( |  const   | iOrigin, | 
 |  const   | iProduct)   | 
  - 
 Sets the Part Axis System defining the machining axis system.
 
  -  Parameters:
  
 - 
    
    -  iOrigin
   
 -   The origin elemnt
 
 
    -  iProduct
   
 -   The belonging product
 
 
 
  o SetUsePAS
  |   public virtual   SetUsePAS( |  const   | iUsedPAS)   | 
  - 
 Sets if a Part Axis System is used or not.
 
  -  Parameters:
  
 - 
    
    -  iUsedPAS
   
 -   The flag
 
 
 
  o SetXDirection
  |   public virtual   SetXDirection( |  const   | iDirection)   | 
  - 
 Sets the X direction of the machining axis system.
 Set mode to Manual before using this method with 
 
  -  Parameters:
  
 - 
    
    -  iDirection
   
 -   The mathematical direction
 
 
 
  o SetZDirection
  |   public virtual   SetZDirection( |  const   | iDirection)   | 
  - 
 Sets the Z direction of the machining axis system.
 Set mode to Manual before using this method with 
 
  -  Parameters:
  
 - 
    
    -  iDirection
   
 -   The mathematical direction
 
 
 
  o UseGeometricPoint
  |   public virtual   UseGeometricPoint( |   | oFlag)   | 
  - 
 Outputs if a geometrical point is used or not.
 
  -  Parameters:
  
 - 
    
    -  oFlag
   
 -   The use of a geometrical point
 
 
 
 This object is included in the file: DELIMfgMachiningAxisSystem.h
If needed, your Imakefile.mk should include the module: MachiningUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.