All Frameworks  Class Hierarchy  This Framework  Indexes   

ManufacturingInterfaces Interface CATIMfgMachiningAxisSystem

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


interface CATIMfgMachiningAxisSystem

Interface dedicated to machining axis system.
Role: This interface offers services mainly to manage the Machining Axis System object


Method Index


o GetAxisSelectMode(char&,CATUnicodeString&)
Gets the type of selection mode defined for the given axis.
o GetAxisType(CATUnicodeString&)
Gets the machining axis type.
o GetAxis(CATMathAxis&)
Gets the mathematical definition of the machining axis system.
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(CATIMfgGeometryAccess_var&)
Gets the Part Axis System of the definition of the Machining Axis System.
o GetPositionGeometry(CATIMfgGeometryAccess_var&)
Gets the positioning geometry of the machining axis system.
o GetUseGeometryForX(boolean&)
Retrieves if a geometric element is used or not in a machining axis system for X definition.
o GetUseGeometryForZ(boolean&)
Retrieves if a geometric element is used or not in a machining axis system for Z definition.
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 SetAxisSelectMode(char&,CATUnicodeString&)
Sets the type of selection mode defined for the given axis.
o SetAxisType(CATUnicodeString&)
Sets the machining axis type.
o SetIsOrigin(int)
Sets if the machining axis system is used as an origin.
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 SetOrigin(CATBaseUnknown_var&,CATBaseUnknown_var&)
Sets the geometic element defining the origin of a 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 GetAxisSelectMode
public virtual GetAxisSelectMode( const iAxis,
oSelectMode)
Gets the type of selection mode defined for the given axis.
Parameters:
iAxis
Type of axis
Legal values:
  • X: for the X direction
  • Z: for the Z direction
oSelectMode.
The selection mode.
Legal values:
  • Mfg_ToolAxis_Mode_Manual: manual mode
  • Mfg_ToolAxis_Mode_PtView: point in view mode
  • Mfg_ToolAxis_Mode_Selection: selection mode
  • Mfg_ToolAxis_Mode_NormalBottom: normal to bottom mode
  • Mfg_ToolAxis_Mode_Axis: axis mode
  • Mfg_ToolAxis_Mode_NormalView: normal view mode
  • Mfg_ToolAxis_Mode_2Rotations: two rotations mode
o GetAxisType
public virtual GetAxisType( oAxisType)
Gets the machining axis type.
Parameters:
oAxisType
The type
o GetAxis
public virtual GetAxis( oAxis)
Gets the mathematical definition of the machining axis system.
Parameters:
oAxis
The mathematical axis
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 GetUseGeometryForX
public virtual GetUseGeometryForX( oUsedGeometry)
Retrieves if a geometric element is used or not in a machining axis system for X definition.
Parameters:
oUsedGeometry
The output
o GetUseGeometryForZ
public virtual GetUseGeometryForZ( UsedGeometry)
Retrieves if a geometric element is used or not in a machining axis system for Z definition.
Parameters:
oUsedGeometry
The output
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
public virtual 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 SetAxisSelectMode
public virtual SetAxisSelectMode( const iAxis,
iSelectMode)
Sets the type of selection mode defined for the given axis. Set mode to Manual to modify the Axis direction using SetXDirection and SetZDirection
Parameters:
iAxis
Type of axis
Legal values:
  • X: for the X direction
  • Z: for the Z direction
iSelectMode
The selection mode.
Legal values:
  • Mfg_ToolAxis_Mode_Manual: manual mode
  • Mfg_ToolAxis_Mode_PtView: point in view mode
  • Mfg_ToolAxis_Mode_Selection: selection mode
  • Mfg_ToolAxis_Mode_NormalBottom: normal to bottom mode
  • Mfg_ToolAxis_Mode_Axis: axis mode
  • Mfg_ToolAxis_Mode_NormalView: normal view mode
  • Mfg_ToolAxis_Mode_2Rotations: two rotations mode
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 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 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 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 SetAxisSelectMode
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 SetAxisSelectMode
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: CATIMfgMachiningAxisSystem.h
If needed, your Imakefile.mk should include the module: MfgItfEnv

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