MachiningOperationUseItf Interface DELIMfgAxialOperation

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


interface DELIMfgAxialOperation

Interface dedicated to axial operation management.
Role: This interface offers services to retrieve parameters of the axial operation


Method Index


o GetAxialRadialLinkingMode(int&)
Retrieves the value of the Axial-Radial Linking parameter.
o GetBackDepth(double&)
Retrieves the back depth of the hole associated with the axial operation.
o GetBreakThrough(double&,int)
Retrieves the breakthrough value on the axial operation.
o GetChamferDiameter(double&)
Retrieves the chamfer diameter value on the axial operation.
o GetChamferingPlungeActivated(boolean&)
Retrieves the parameter ChamferingPlungeActivated on the axial operation.
o GetCircularMillingMode(CATUnicodeString&)
Retrieves the circular milling mode on the axial operation.
o GetClearTip(double&)
Retrieves the tip approach clearance on the axial operation.
o GetComputedDepthTip(double&,int)
Retrieves the computed depth tip value from the parameters set on the axial operation.
o GetComputedDwellTime(double&)
Retrieves the computed dwell time value on the axial operation.
o GetCounterSinkDiameter(double&)
Retrieves the countersink diameter of the hole associated with the axial operation.
o GetDecrementLimit(double&)
Retrieves the decrement limit rate value on the axial operation of type deephole.
o GetDecrementRate(double&)
Retrieves the decrement rate value on the axial operation of type deephole.
o GetDeltaDiameter(double&)
Retrieves the delta diameter value on the axial operation.
o GetDeltaIncrement(double&)
Retrieves the delta increment value on the axial operation.
o GetDeltaOffset(double&)
Retrieves the delta offset value on the axial operation.
o GetDeltaTip(double&)
Retrieves the delta tip value on the axial operation.
o GetDepthComputationMode(CATUnicodeString&)
Retrieves the depth computation mode set on the axial operation.
o GetDepthDiameter(double&)
Retrieves the depth diameter value on the axial operation.
o GetDepthDistance(double&)
Retrieves the depth distance value on the axial operation.
o GetDepthOffset(double&)
Retrieves the depth offset value on the axial operation.
o GetDepthTip(double&)
Retrieves the depth tip value on the axial operation.
o GetDetailDepth(double&,int)
Retrieves the detail depth of the hole associated to the axial operation.
o GetDistanceFromCompensation(int&,double&)
Retrieves the correction distance from the tool correction parameters on the axial operation.
o GetDistanceFromFirstCompensation(double&)
Retrieves the correction distance from the first tool correction parameters on the axial operation.
o GetDistanceFromSecondCompensation(double&)
Retrieves the correction distance from the second tool correction parameters on the axial operation.
o GetDwellRound(int&)
Retrieves the dwell revolutions value on the axial operation.
o GetDwellRound(double&)
Retrieves the dwell revolutions value on the axial operation.
o GetDwellTime(int&)
Retrieves the dwell time value on the axial operation.
o GetDwellTime(double&)
Retrieves the dwell time value on the axial operation.
o GetEffectDepthCut(double&,int)
Retrieves the effective depth of cut of a manufacturing feature (deephole and breakchips operations only).
o GetFeatureAngle(double&)
Retrieves the countersink angle of the hole associated with the axial operation.
o GetFeatureDepth(double&)
Retrieves the depth of the hole associated with the axial operation.
o GetFeatureDiameter(double&)
Retrieves the diameter of the hole associated with the axial operation.
o GetFeatureExtension(CATUnicodeString&)
Retrieves the hole extension of a manufacturing feature.
o GetFeaturePitch(double&)
Retrieves the pitch of a manufacturing feature.
o GetFeaturePitchSens(CATUnicodeString&)
Retrieves the pitch sens of a manufacturing feature.
o GetFeatureThreadDiameter(double&)
Retrieves the thread diameter (crest diameter) of a manufacturing feature.
o GetFirstToolCompensationParameters(int&,int&,int&,double&)
Retrieves the first tool corrector number and its parameters on the axial operation.
o GetHelixAngle(double&)
Retrieves the helix angle on the axial operation.
o GetHelixMode(CATUnicodeString&)
Retrieves the helix mode on the axial operation.
o GetHelixPitch(double&)
Retrieves the helix pitch on the axial operation.
o GetHoleMachiningDepth(double&,int)
Retrieves the depth value of Pattern Hole seen as Results and not as Specs.
o GetHoleMachiningDiameter(double&,int)
Retrieves the diameter value of Pattern Hole.
o GetHoleMachiningExtension(CATUnicodeString&,int)
Retrieves the Extension value of Pattern Hole.
o GetJumpDistance(double&)
Retrieves the jump distance on the axial operation.
o GetLiftAngle(double&)
Retrieves the lift angle value on the axial operation.
o GetLiftWay(double&)
Retrieves the lift way value on the axial operation.
o GetLiftX(double&)
Retrieves the lift X value on the axial operation.
o GetLiftY(double&)
Retrieves the lift Y value on the axial operation.
o GetLiftZ(double&)
Retrieves the lift Z value on the axial operation.
o GetMaxDepthOfCut(double&)
Retrieves the max depth of cut value on the axial operation of type breakchips or deephole.
o GetOperationAxis(CATMathVector&)
Retrieves the Z axis on the axial operation.
o GetOperationAxis(CATMathVector&,CATMathVector&,CATMathVector&)
Retrieves the Z axis, X axis and Y axis on the axial operation.
o GetOutputCycleSyntax(CATBoolean&)
Retrieves the output syntax (GOTO or CYCLE).
o GetPlungeDiameter(double&)
Retrieves the plunge diameter value on the axial operation.
o GetPlungeDist(double&)
Retrieves the computed plunge distance on the axial operation.
o GetPlungeDistance(double&)
Retrieves the plunge distance value on the axial operation.
o GetPlungeOffset(double&)
Retrieves the plunge offset value on the axial operation.
o GetPlungeTip(double&)
Retrieves the plunge tip value on the axial operation.
o GetRetractClearTip(double&)
Retrieves the retract clear tip of the axial operation (Back Boring).
o GetRetractOffset(double&)
Retrieves the retract offset value on the axial operation of type breakchips or deephole.
o GetSecondClearTip(double&)
Retrieves the second tip approach clearance on the axial operation.
o GetSecondToolCompensationParameters(int&,int&,int&,double&)
Retrieves the second tool corrector number and its parameters on the axial operation.
o GetSlotDiameter(double&)
Retrieves the slot diameter of the hole associated with the axial operation.
o GetSpotDiameter(double&)
Retrieves the spot diameter value on the axial operation.
o GetSpotDistance(double&)
Retrieves the spot distance value on the axial operation.
o GetSpotOffset(double&)
Retrieves the spot offset value on the axial operation.
o GetSpotTip(double&)
Retrieves the spot tip value on the axial operation.
o GetThreadType(CATUnicodeString&)
Retrieves the thread type (internal or external) of a manufacturing feature.
o GetToolAxisOrientation(int&)
Determines wether the ToolAxis of the axial operation is inverted or not.
o GetToolCompensationParameters(int&,int&,int&,double&)
Retrieves the parameters on the axial operation of the tool corrector number specified.
o GetToolNumber(int&)
Retrieves the tool number of the tool associated to the axial operation.
o GetTotalDepth(double&,int)
Retrieves the total depth of the hole associated to the axial operation.

Methods


o GetAxialRadialLinkingMode
public virtual GetAxialRadialLinkingMode( oAxialRadialLinkingMode)
Retrieves the value of the Axial-Radial Linking parameter.
Parameters:
oAxialRadialLinkingMode
0 : Straight line 1 : Axial-Radial move
o GetBackDepth
public virtual GetBackDepth( oBackDepth)
Retrieves the back depth of the hole associated with the axial operation.
Parameters:
oBackDepth
The back depth value
o GetBreakThrough
public virtual GetBreakThrough( oBreakthroughValue,
iHoleNumber= NULL)
Retrieves the breakthrough value on the axial operation.
Parameters:
oBreakthroughValue
The breakthrough value
iHoleNumber
The number of the Pattern Hole on which the Breakthrough has to be retrieved (depends of the Extension of the hole) if NULL, the ItemToCopy is taken into account
o GetChamferDiameter
public virtual GetChamferDiameter( oChamferDiameterValue)
Retrieves the chamfer diameter value on the axial operation.
Parameters:
oChamferDiameterValue
The chamfer diameter value
o GetChamferingPlungeActivated
public virtual GetChamferingPlungeActivated( oChamferingPlungeActivated)
Retrieves the parameter ChamferingPlungeActivated on the axial operation. This method only concerns Boring and Chamfering.
Parameters:
oChamferingPlungeActivated
The ChamferingPlungeActivated value
o GetCircularMillingMode
public virtual GetCircularMillingMode( oMode)
Retrieves the circular milling mode on the axial operation.
Parameters:
oMode
The circular milling mode value
o GetClearTip
public virtual GetClearTip( oClearTipValue)
Retrieves the tip approach clearance on the axial operation.
Parameters:
oClearTipValue
The tip approach clearance value
o GetComputedDepthTip
public virtual GetComputedDepthTip( oTotalDepthValue,
iHoleNumber= NULL)
Retrieves the computed depth tip value from the parameters set on the axial operation.
Parameters:
oTotalDepthValue
The computed total depth tip value
iHoleNumber
The number of the Hole on which the DepthTip has to be computed if NULL, the ItemToCopy is taken into account
o GetComputedDwellTime
public virtual GetComputedDwellTime( oComputedDwellTimeValue)
Retrieves the computed dwell time value on the axial operation.
Parameters:
oComputedDwellTimeValue
The computed dwell time value
o GetCounterSinkDiameter
public virtual GetCounterSinkDiameter( oCSDiameter)
Retrieves the countersink diameter of the hole associated with the axial operation.
Parameters:
oCSDiameter
The countersink diameter value
o GetDecrementLimit
public virtual GetDecrementLimit( oDecrementLimitValue)
Retrieves the decrement limit rate value on the axial operation of type deephole.
Parameters:
oDecrementLimitValue
The decrement limit rate value
o GetDecrementRate
public virtual GetDecrementRate( oDecrementRateValue)
Retrieves the decrement rate value on the axial operation of type deephole.
Parameters:
oDecrementRateValue
The decrement rate value
o GetDeltaDiameter
public virtual GetDeltaDiameter( oDeltaDiameterValue)
Retrieves the delta diameter value on the axial operation.
Parameters:
oDeltaDiameterValue
The delta diameter value
o GetDeltaIncrement
public virtual GetDeltaIncrement( oDeltaIncrementValue)
Retrieves the delta increment value on the axial operation.
Parameters:
oDeltaIncrementValue
The delta increment value
o GetDeltaOffset
public virtual GetDeltaOffset( oDeltaOffsetValue)
Retrieves the delta offset value on the axial operation.
Parameters:
oDeltaOffsetValue
The delta offset value
o GetDeltaTip
public virtual GetDeltaTip( oDeltaTipValue)
Retrieves the delta tip value on the axial operation.
Parameters:
oDeltaTipValue
The delta offset value
o GetDepthComputationMode
public virtual GetDepthComputationMode( oCurrentMode)
Retrieves the depth computation mode set on the axial operation.
Parameters:
oCurrentMode
The current depth mode value
Legal values:
  • MfgDepthDefault
  • MfgDepthTip
  • MfgDepthDiameter
  • MfgDepthDistance
  • MfgDepthShoulder
o GetDepthDiameter
public virtual GetDepthDiameter( oDepthDiameterValue)
Retrieves the depth diameter value on the axial operation.
Parameters:
oDepthDiameterValue
The depth diameter value
o GetDepthDistance
public virtual GetDepthDistance( oDepthDistanceValue)
Retrieves the depth distance value on the axial operation.
Parameters:
oDepthDistanceValue
The depth distance value
o GetDepthOffset
public virtual GetDepthOffset( oDepthOffsetValue)
Retrieves the depth offset value on the axial operation.
Parameters:
oDepthOffsetValue
The depth offset value
o GetDepthTip
public virtual GetDepthTip( oDepthTipValue)
Retrieves the depth tip value on the axial operation.
Parameters:
oDepthTipValue
The depth tip value
o GetDetailDepth
public virtual GetDetailDepth( oDetailDepthValue,
iHoleNumber= NULL)
Retrieves the detail depth of the hole associated to the axial operation.
Parameters:
oDetailDepthValue
The detail depth value
iHoleNumber
The number of the Hole on which the DetailDepth has to be computed if NULL, the ItemToCopy is taken into account
o GetDistanceFromCompensation
public virtual GetDistanceFromCompensation( iCorrectorNumber,
oDistance)
Retrieves the correction distance from the tool correction parameters on the axial operation.
Parameters:
iCorrectorNumber
The corrector number specified.
oDistance
The correction distance
o GetDistanceFromFirstCompensation
public virtual GetDistanceFromFirstCompensation( oDistance)
Retrieves the correction distance from the first tool correction parameters on the axial operation.
Parameters:
oDistance
The correction distance
o GetDistanceFromSecondCompensation
public virtual GetDistanceFromSecondCompensation( oDistance)
Retrieves the correction distance from the second tool correction parameters on the axial operation.
Parameters:
oDistance
The correction distance
o GetDwellRound
public virtual GetDwellRound( oDwellRoundValue)
Retrieves the dwell revolutions value on the axial operation.
Parameters:
oDwellRoundValue
The dwell revolutions value
o GetDwellRound
public virtual GetDwellRound( oDwellRoundValue)
Retrieves the dwell revolutions value on the axial operation.
Parameters:
oDwellRoundValue
The dwell revolutions value
o GetDwellTime
public virtual GetDwellTime( oDwellTimeValue)
Retrieves the dwell time value on the axial operation.
Parameters:
oDwellTimeValue
The dwell time value
o GetDwellTime
public virtual GetDwellTime( oDwellTimeValue)
Retrieves the dwell time value on the axial operation.
Parameters:
oDwellTimeValue
The dwell time value
o GetEffectDepthCut
public virtual GetEffectDepthCut( oEffectDepthCut,
iHoleNumber= NULL)
Retrieves the effective depth of cut of a manufacturing feature (deephole and breakchips operations only).
Parameters:
oEffectDepthCut
The effective depth of cut value
o GetFeatureAngle
public virtual GetFeatureAngle( oAngle)
Retrieves the countersink angle of the hole associated with the axial operation.
Parameters:
oAngle
The countersink angle value
o GetFeatureDepth
public virtual GetFeatureDepth( oDepth)
Retrieves the depth of the hole associated with the axial operation.
Parameters:
oDepth
The hole depth value
o GetFeatureDiameter
public virtual GetFeatureDiameter( oDiameter)
Retrieves the diameter of the hole associated with the axial operation.
Parameters:
oDiameter
The hole diameter value
o GetFeatureExtension
public virtual GetFeatureExtension( oHoleExtension)
Retrieves the hole extension of a manufacturing feature.
Parameters:
oHoleExtension
The hole extension value
o GetFeaturePitch
public virtual GetFeaturePitch( oPitch)
Retrieves the pitch of a manufacturing feature.
Parameters:
oPitch
The pitch value
o GetFeaturePitchSens
public virtual GetFeaturePitchSens( oPitchSens)
Retrieves the pitch sens of a manufacturing feature.
Parameters:
oPitchSens
The pitch sens value
o GetFeatureThreadDiameter
public virtual GetFeatureThreadDiameter( oThreadDiameter)
Retrieves the thread diameter (crest diameter) of a manufacturing feature.
Parameters:
oThreadDiameter
The thread diameter value
o GetFirstToolCompensationParameters
public virtual GetFirstToolCompensationParameters( oCorrectorNumber,
oLengthNumber,
oRadiusNumber,
oDiameter)
Retrieves the first tool corrector number and its parameters on the axial operation.
Parameters:
oCorrectorNumber
The corrector number
oLengthNumber
The length number
oRadiusNumber
The radius number
oDiameter
The diameter value
o GetHelixAngle
public virtual GetHelixAngle( oAngle)
Retrieves the helix angle on the axial operation.
Parameters:
oAngle
The helix angle value
o GetHelixMode
public virtual GetHelixMode( oMode)
Retrieves the helix mode on the axial operation.
Parameters:
oMode
The helix mode value
o GetHelixPitch
public virtual GetHelixPitch( oPitch)
Retrieves the helix pitch on the axial operation.
Parameters:
oPitch
The helix pitch value
o GetHoleMachiningDepth
public virtual GetHoleMachiningDepth( oMachDepth,
iHoleNumber= NULL)
Retrieves the depth value of Pattern Hole seen as Results and not as Specs.
Parameters:
oResultDepth
The depth value seen as results and not as specs
iHoleNumber
The number of the Pattern Hole on which the ResultDepth has to be retrieved if NULL, the ItemToCopy is taken into account
o GetHoleMachiningDiameter
public virtual GetHoleMachiningDiameter( oMachDiam,
iHoleNumber= NULL)
Retrieves the diameter value of Pattern Hole.
Parameters:
oResultDiameter
The diameter value seen as results and not as specs
iHoleNumber
The number of the Pattern Hole on which the ResultDiameter has to be retrieved if NULL, the ItemToCopy is taken into account
o GetHoleMachiningExtension
public virtual GetHoleMachiningExtension( oMachExt,
iHoleNumber= NULL)
Retrieves the Extension value of Pattern Hole.
Parameters:
oMachExt
The extension value (MfgBlind / MfgThrough)
iHoleNumber
The number of the Pattern Hole on which the Extension has to be retrieved if NULL, the ItemToCopy is taken into account
o GetJumpDistance
public virtual GetJumpDistance( oJumpDistanceValue)
Retrieves the jump distance on the axial operation.
Parameters:
oJumpDistanceValue
The jump distance value
o GetLiftAngle
public virtual GetLiftAngle( oLiftAngleValue)
Retrieves the lift angle value on the axial operation.
Parameters:
oLiftAngleValue
The lift angle value
o GetLiftWay
public virtual GetLiftWay( oLiftWayValue)
Retrieves the lift way value on the axial operation.
Parameters:
oLiftWayValue
The lift way value
o GetLiftX
public virtual GetLiftX( oLiftXValue)
Retrieves the lift X value on the axial operation.
Parameters:
oLiftXValue
The lift X value
o GetLiftY
public virtual GetLiftY( oLiftYValue)
Retrieves the lift Y value on the axial operation.
Parameters:
oLiftYValue
The lift Y value
o GetLiftZ
public virtual GetLiftZ( oLiftZValue)
Retrieves the lift Z value on the axial operation.
Parameters:
oLiftZValue
The lift Z value
o GetMaxDepthOfCut
public virtual GetMaxDepthOfCut( oMaxDepthOfCutValue)
Retrieves the max depth of cut value on the axial operation of type breakchips or deephole.
Parameters:
oMaxDepthOfCutValue
The max depth of cut value
o GetOperationAxis
public virtual GetOperationAxis( oZAxis)
Retrieves the Z axis on the axial operation.
Parameters:
oZAxis
The Z axis value
o GetOperationAxis
public virtual GetOperationAxis( oZAxis,
oXAxis,
oYAxis)
Retrieves the Z axis, X axis and Y axis on the axial operation.
Parameters:
oZAxis
The Z axis value
oXAxis
The X axis value
oYAxis
The Y axis value
o GetOutputCycleSyntax
public virtual GetOutputCycleSyntax( oOutputCycleSyntax)
Retrieves the output syntax (GOTO or CYCLE).
Parameters:
oOutputCycleSyntax
GOTO/CYCLE <-> False/True
o GetPlungeDiameter
public virtual GetPlungeDiameter( oPlungeDiameterValue)
Retrieves the plunge diameter value on the axial operation.
Parameters:
oPlungeDiameterValue
The plunge diameter value
o GetPlungeDist
public virtual GetPlungeDist( oPlungeDistValue)
Retrieves the computed plunge distance on the axial operation.
Parameters:
oPlungeDistValue
The computed plunge distance value
o GetPlungeDistance
public virtual GetPlungeDistance( oPlungeDistanceValue)
Retrieves the plunge distance value on the axial operation.
Parameters:
oPlungeDistanceValue
The plunge distance value
o GetPlungeOffset
public virtual GetPlungeOffset( oPlungeOffsetValue)
Retrieves the plunge offset value on the axial operation.
Parameters:
oPlungeOffsetValue
The plunge offset value
o GetPlungeTip
public virtual GetPlungeTip( oPlungeTipValue)
Retrieves the plunge tip value on the axial operation.
Parameters:
oPlungeTipValue
The plunge tip value
o GetRetractClearTip
public virtual GetRetractClearTip( oRetractClearTip)
Retrieves the retract clear tip of the axial operation (Back Boring).
Parameters:
oRetractClearTip
The retract clear tip value
o GetRetractOffset
public virtual GetRetractOffset( oRetractOffsetValue)
Retrieves the retract offset value on the axial operation of type breakchips or deephole.
Parameters:
oRetractOffsetValue
The retract offset value
o GetSecondClearTip
public virtual GetSecondClearTip( oSecondClearTipValue)
Retrieves the second tip approach clearance on the axial operation.
Parameters:
oSecondClearTipValue
The second tip approach clearance value
o GetSecondToolCompensationParameters
public virtual GetSecondToolCompensationParameters( oCorrectorNumber,
oLengthNumber,
oRadiusNumber,
oDiameter)
Retrieves the second tool corrector number and its parameters on the axial operation.
Parameters:
oCorrectorNumber
The corrector number
oLengthNumber
The length number
oRadiusNumber
The radius number
oDiameter
The diameter value
o GetSlotDiameter
public virtual GetSlotDiameter( oSlotDiameter)
Retrieves the slot diameter of the hole associated with the axial operation.
Parameters:
oSlotDiameter
The slot diameter as double
o GetSpotDiameter
public virtual GetSpotDiameter( oDiameterValue)
Retrieves the spot diameter value on the axial operation.
Parameters:
oDiameterValue
The spot diameter value
o GetSpotDistance
public virtual GetSpotDistance( oSpotDistanceValue)
Retrieves the spot distance value on the axial operation.
Parameters:
oSpotDistanceValue
The spot distance value
o GetSpotOffset
public virtual GetSpotOffset( oSpotOffsetValue)
Retrieves the spot offset value on the axial operation.
Parameters:
oSpotOffsetValue
The spot offset value
o GetSpotTip
public virtual GetSpotTip( oSpotTipValue)
Retrieves the spot tip value on the axial operation.
Parameters:
oSpotTipValue
The spot tip value
o GetThreadType
public virtual GetThreadType( oThreadType)
Retrieves the thread type (internal or external) of a manufacturing feature.
Parameters:
oThreadType
The thread type value
o GetToolAxisOrientation
public virtual GetToolAxisOrientation( oToolAxisOrientation)
Determines wether the ToolAxis of the axial operation is inverted or not.
Parameters:
oToolAxisOrientation
-1 if the ToolAxis of the axial operation is inverted 1 otherwise
o GetToolCompensationParameters
public virtual GetToolCompensationParameters( iCorrectorNumber,
oLengthNumber,
oRadiusNumber,
oDiameter)
Retrieves the parameters on the axial operation of the tool corrector number specified.
Parameters:
iCorrectorNumber
The corrector number
oLengthNumber
The length number
oRadiusNumber
The radius number
oDiameter
The diameter value
o GetToolNumber
public virtual GetToolNumber( oToolNumberValue)
Retrieves the tool number of the tool associated to the axial operation.
Parameters:
oToolNumberValue
The tool number value
o GetTotalDepth
public virtual GetTotalDepth( oTotalDepthValue,
iHoleNumber= NULL)
Retrieves the total depth of the hole associated to the axial operation.
Parameters:
oTotalDepthValue
The total depth value
iHoleNumber
The number of the Hole on which the TotalDepth has to be computed if NULL, the ItemToCopy is taken into account

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.