All Frameworks Class Hierarchy This Framework Previous Next Indexes
ManufacturingInterfaces Interface CATIMfgMachiningAxisSystem
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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
GetAxis(CATMathAxis&)
- Gets the mathematical definition of the machining axis system.
- o
GetAxisSelectMode(char&,CATUnicodeString&)
- Gets the type of selection mode defined for the given axis.
- 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(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
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
-
Gets the mathematical definition of the machining axis system.
- Parameters:
-
- oAxis
- The mathematical axis
o GetAxisSelectMode
-
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
-
Gets the machining axis type.
- Parameters:
-
- oAxisType
- The type
o GetIsOrigin
public virtual HRESULT GetIsOrigin( | int& | oFlag)const=0 |
-
Gets if the machining axis system is an origin.
- Parameters:
-
- oFlag
- The flag
o GetOriginGroup
public virtual HRESULT GetOriginGroup( | int& | Flag)const=0 |
-
Gets the origin group in case of an origin usage.
- Parameters:
-
- oString
- The mode
o GetOriginNumber
public virtual HRESULT GetOriginNumber( | int& | oFlag)const=0 |
-
Gets the origin number in case of an origin usage.
- Parameters:
-
- oFlag
- The origin number
o GetOriginPoint
-
Gets the origin point of the machining axis system.
- Parameters:
-
- oPoint
- The mathematical point
o GetPAS
public virtual HRESULT GetPAS( | CATIMfgGeometryAccess_var& | oPAS) const =0 |
-
Gets the Part Axis System of the definition of the Machining Axis System.
- Parameters:
-
- oPAS
- The part axis system
o GetPositionGeometry
public virtual HRESULT GetPositionGeometry( | CATIMfgGeometryAccess_var& | oGeometry) const =0 |
-
Gets the positioning geometry of the machining axis system.
- Parameters:
-
- oGeometry
- The geometry
o GetUseGeometryForX
public virtual HRESULT GetUseGeometryForX( | boolean& | oUsedGeometry) const =0 |
-
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 HRESULT GetUseGeometryForZ( | boolean& | UsedGeometry) const =0 |
-
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 HRESULT GetUsePAS( | boolean& | oUsedPAS)const =0 |
-
Retrieves if a Part Axis System is used or not in a machining axis system.
- Parameters:
-
- oUsedPAS
- The output
o GetXDirection
-
Gets the X direction of the machining axis system.
- Parameters:
-
- oDirection
- The mathematical direction
o GetYDirection
-
Gets the Y direction of the machining axis system.
- Parameters:
-
- oDirection
- The mathematical direction
o GetZDirection
-
Gets the Z direction of the machining axis system.
- Parameters:
-
- oDirection
- The mathematical direction
o IsComplete
public virtual int IsComplete( | )=0 |
-
Checks if Machining Axis System is complete.
o IsOK
public virtual HRESULT IsOK( | )const =0 |
-
Checks if the MAchining Axis System definition is OK.
o IsUpToDate
public virtual int IsUpToDate( | )=0 |
-
Checks if Machining Axis System is up to date.
o ModifyOriginPoint
-
Modifies the origin point of the machining axis system.
- Parameters:
-
- iPoint
- The mathematical point
o Normalize
public virtual HRESULT Normalize( | )=0 |
-
Normalizes the machining axis system.
o SetAxisSelectMode
-
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
-
Sets the machining axis type.
- Parameters:
-
- iAxisType
- The type
o SetIsOrigin
public virtual HRESULT SetIsOrigin( | const int | iFlag)=0 |
-
Sets if the machining axis system is used as an origin.
- Parameters:
-
- iFlag
- The flag
o SetOrigin
-
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 HRESULT SetOriginGroup( | const int | iFlag)=0 |
-
Sets the origin group number in case of an origin usage.
- Parameters:
-
- iFlag
- The flag
o SetOriginNumber
public virtual HRESULT SetOriginNumber( | const int | iFlag)=0 |
-
Sets the origin number in case of an origin usage.
- Parameters:
-
- iFlag
- The flag
o SetOriginPoint
-
Sets the origin point of the machining axis system.
- Parameters:
-
- iPoint
- The mathematical point
o SetPAS
-
Sets the Part Axis System defining the machining axis system.
- Parameters:
-
- iOrigin
- The origin elemnt
- iProduct
- The belonging product
o SetUsePAS
public virtual HRESULT SetUsePAS( | const boolean | iUsedPAS)=0 |
-
Sets if a Part Axis System is used or not.
- Parameters:
-
- iUsedPAS
- The flag
o SetXDirection
-
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
-
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 HRESULT UseGeometricPoint( | int& | oFlag)const=0 |
-
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