All Frameworks Class Hierarchy This Framework Previous Next Indexes
ManufacturingInterfaces Interface CATIMfgAxialToolPathGeneratorBase
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIMfgAxialToolPathGeneratorBase
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMfgAxialToolPathGeneratorBase
Interface dedicated to axial operation management.
Role: This interface offers services for toolpath computation.
Method Index
- o
CalculateDiameterFromTip(double&,double&,CATBoolean&)
- Calculates the equivalent diameter distance to a tip value.
- o
CalculateTipFromDiameter(double&,double&,double&,CATBoolean&)
- Calculates the equivalent tip distance to a diameter value.
- o
CreateAxialToolPath(CATIContainer_var&,CATMathVector&)
- Creates and returns a tool path initialized by the axial operation and a given operation axis.
- o
CreateAxialToolPath(CATIContainer_var)
- Creates a tool path initialized by the axial operation.
- o
GetOperationGeometry(CATMathVector&,CATBoolean&,double&)
- Retrieves the axis value , the length validity flag and the length value of the axial operation.
- o
GetOperationGeometry(CATMathVector&,CATBoolean&,double&,CATBoolean&,double&)
- Retrieves the axis value, the length validity flag, the length value,
the diameter validity flag and the diameter value of the axial operation.
- o
GetOperationGeometry(CATMathVector&,CATMathVector&,CATMathVector&,CATBoolean&,double&)
- Retrieves the X axis value, the Y axis value, the Z axis value, the length validity flag and the length value
of the axial operation.
- o
GetOperationPattern(CATMathSetOfPoints&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,int&,int,int)
- Retrieves parameters on the pattern associated with the axial operation.
- o
GetOperationPattern(CATMathSetOfPoints&,CATListOfDouble&,CATListOfDouble&,int&,int,int)
- Retrieves parameters on the pattern associated with the axial operation.
- o
GetOperationPattern(CATMathSetOfPoints&,CATMathSetOfVectors&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,int&,int,int)
- Retrieves parameters on the pattern associated with the axial operation.
- o
GetToolCMassLength(double&)
- Retrieves the C mass length of the tool associated with the axial operation.
- o
GetToolTipLength(double&)
- Retrieves the tool tip length of the tool associated with the axial operation.
Methods
o CalculateDiameterFromTip
public virtual HRESULT CalculateDiameterFromTip( | const double& | iTip, |
| double& | oDiameter, |
| CATBoolean& | oDiameterOk) = 0 |
-
Calculates the equivalent diameter distance to a tip value.
- Parameters:
-
- iTip
- The tip distance value
- oDiameter
- The diameter distance value
- oDiameterOk
- The diameter distance calculation flag
Legal values:
- TRUE: calculation has been successfull
- FALSE: calculation has failed
o CalculateTipFromDiameter
public virtual HRESULT CalculateTipFromDiameter( | const double& | iDiameter, |
| const double& | iOffset, |
| double& | oTip, |
| CATBoolean& | oTipOk) = 0 |
-
Calculates the equivalent tip distance to a diameter value.
- Parameters:
-
- iDiameter
- The diameter distance value
- iOffset
- The offset value on the diameter
- oTip
- The tip distance value
- oTipOk
- The tip distance calculation flag
Legal values:
- TRUE: calculation has been successfull
- FALSE: calculation has failed
o CreateAxialToolPath
-
Creates and returns a tool path initialized by the axial operation and a given operation axis.
- Parameters:
-
- iContainer
- The tool path container
- iAxis
- The axis value
o CreateAxialToolPath
-
Creates a tool path initialized by the axial operation.
- Parameters:
-
- iContainer
- The tool path container
o GetOperationGeometry
-
Retrieves the axis value , the length validity flag and the length value of the axial operation.
- Parameters:
-
- oAxis
- The axis value
- oLengthOk
- The length validity flag
Legal values:
- TRUE: the length value can be read
- FALSE: the length value can not be read
- oLength
- The length value
o GetOperationGeometry
-
Retrieves the axis value, the length validity flag, the length value,
the diameter validity flag and the diameter value of the axial operation.
- Parameters:
-
- oAxis
- The axis value
- oLengthOk
- The length validity flag
Legal values:
- TRUE: the length value can be read
- FALSE: the length value can not be read
- oLength
- The length value
- oDiameterOk
- The diameter validity flag
Legal values:
- TRUE: the diameter value can be read
- FALSE: the diameter value can not be read
- oDiameter
- The diameter value
o GetOperationGeometry
-
Retrieves the X axis value, the Y axis value, the Z axis value, the length validity flag and the length value
of the axial operation.
- Parameters:
-
- oXAxis
- The X axis value
- oYAxis
- The Y axis value
- oZAxis
- The Z axis value
- oLengthOk
- The length validity flag
Legal values:
- TRUE: the length value can be read
- FALSE: the length value can not be read
- oLength
- The length value
o GetOperationPattern
-
Retrieves parameters on the pattern associated with the axial operation.
- Parameters:
-
- oPoints
- The list of points from the pattern
- oEntryDistances
- The list of entry distances
- oExitDistances
- The list of exit distances
- oDephts
- The list of depths
- oNbOfPoints
- The number of points in the pattern
- iAsResult
- The number of points in the pattern
Legal values:
- 0: Design specifications for oPoints, oAxis and oOffsets
- 1: Computation as Result for oPoints, oAxis and oOffsets
o GetOperationPattern
-
Retrieves parameters on the pattern associated with the axial operation.
- Parameters:
-
- oPoints
- The list of points from the pattern
- oEntryDistances
- The list of entry distances
- oExitDistances
- The list of exit distances
- oNbOfPoints
- The number of points in the pattern
- iAsResult
- The number of points in the pattern
Legal values:
- 0: Design specifications for oPoints, oAxis and oOffsets
- 1: Computation as Result for oPoints, oAxis and oOffsets
o GetOperationPattern
-
Retrieves parameters on the pattern associated with the axial operation.
- Parameters:
-
- oPoints
- The list of points from the pattern
- oAxis
- The list of axis from the pattern
- oEntryDistances
- The list of entry distances
- oExitDistances
- The list of exit distances
- oDephts
- The list of depths
- oOffsets
- The list of the offsets between the machining points and theirs projections on the top elements
- oNbOfPoints
- The number of points in the pattern
- iAsResult
- Defines if the values are done as specifications, or as result
Legal values:
- 0: Design specifications for oPoints, oAxis and oOffsets
- 1: Computation as Result for oPoints, oAxis and oOffsets
- iTakeActualStockIntoAccount
- Defines if the stock is taken into account for the outputed values
Legal values:
- 0: The stock is not taken into account
- 1: The stock have an influence upon oOperationPoints and oOperationOffsets
o GetToolCMassLength
public virtual HRESULT GetToolCMassLength( | double& | oToolCMassLength) = 0 |
-
Retrieves the C mass length of the tool associated with the axial operation.
- Parameters:
-
- oToolCMassLength
- The C mass length value
o GetToolTipLength
public virtual HRESULT GetToolTipLength( | double& | oToolTipLength) = 0 |
-
Retrieves the tool tip length of the tool associated with the axial operation.
- Parameters:
-
- oToolTipLength
- The tool tip length value
This object is included in the file: CATIMfgAxialToolPathGeneratorBase.h
If needed, your Imakefile.mk should include the module: MfgItfEnv