MachiningUseItf Interface DELIMfgElementaryMotion

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

interface DELIMfgElementaryMotion

Interface to manage the elementary motion of a macro.

Method Index


o AddPPWord(CATString&)
Add a PPWord.
o GetAngularOrientationValue(double&)
Read AngularOrientationValue from an Elementary Motion if ElementaryMotionType = Circular.
o GetAngularSectorValue(double&)
Read AngularSectorValue from an Elementary Motion if ElementaryMotionType = Circular.
o GetCircleRadiusValue(double&)
Read CircleRadiusValue from an Elementary Motion if ElementaryMotionType = Circular.
o GetDistanceValue(double&)
Read a DistanceValue from an Elementary Motion if ElementaryMotionType = Horizontal or Axial or DeltaLnDist.
o GetElementaryMotionType(int&)
Read the type of an Elementary Motion.
o GetFeedrateType(int&)
Read a feedrateType From an Elementary Motion.
o GetFeedrateValue(double&)
Read a feedrateValue from an Elementary Motion if FeedrateType = Local /Undefined Feedrate/.
o GetHorizontalAngleValue(double&)
Read a HorizontalAngleValue from an Elementary Motion if ElementaryMotionType = Horizontal.
o GetHorizontalSafetyDistanceValue(double&)
Read HorizontalSafetyDistanceValue from an Elementary Motion if ElementaryMotionType = Ramping.
o GetMotionDirectionVector(CATMathVector&)
Read DirectionVector from an Elementary Motion if ElementaryMotionType = DeltaLnDist.
o GetMotionPlane(CATMathPlane&)
Read Plane from an Elementary Motion if ElementaryMotionType = GoToAPlane.
o GetMotionPoint(CATMathPoint&)
Read Point from an Elementary Motion if ElementaryMotionType = GoToAPpoint.
o GetMotionToPlaneMode(int&)
Read the way to move to the Plane from an Elementary Motion if ElementaryMotionType = GoToAPlane.
o GetMotionToolAxis(CATMathVector&)
Read DirectionVector from an Elementary Motion if ElementaryMotionType = ToolAxis.
o GetNumberOfPPWord()
Get the number of PPWords.
o GetPPWord(int&,CATUnicodeString&)
Get the index-st PPword.
o GetPPWordList(CATListOfCATUnicodeString&)
Read PPWordList from an Elementary Motion if ElementaryMotionType = PP.
o GetRampingAngleValue(double&)
Read RampingAngleValue from an Elementary Motion if ElementaryMotionType = Ramping.
o GetSpindleSpeedType(int&)
Read a SpindleSpeedType from an Elementary Motion.
o GetSpindleSpeedValue(double&)
Read a SpindleSpeedValue from an Elementary Motion if SpindleSpeedType = Local /Undefined Spindle Speed.
o GetVerticalAngleValue(double&)
Read a VerticalAngleValue from an Elementary Motion if ElementaryMotionType = Horizontal.
o GetVerticalSafetyDistanceValue(double&)
Read VerticalSafetyDistanceValue from an Elementary Motion if ElementaryMotionType = Ramping.
o IsActive(int&)
Returns if an elementary motion is active or not.
o RemovePPWord()
Remove all the PPWords.
o SetActive()
Set an Elementary Motion to Active Status
    • o SetAngularOrientationValue(double&)
    Set AngularOrientationValue of an Elementary Motion if ElementaryMotionType = Circular.
    o SetAngularSectorValue(double&)
    Set AngularSectorValue of an Elementary Motion if ElementaryMotionType = Circular.
    o SetCircleRadiusValue(double&)
    Set CircleRadiusValue of an Elementary Motion if ElementaryMotionType = Circular.
    o SetDistanceValue(double&)
    Set the DistanceValue of an Elementary Motion if ElementaryMotionType = Horizontal or Axial or DeltaLnDist.
    o SetFeedrateType(int&)
    Set the feedrateType of an Elementary Motion.
    o SetFeedrateValue(double&)
    Set feedrateValue of an Elementary Motion if FeedrateType = Local /Undefined Feedrate/.
    o SetFormulaMotionPlane(CATUnicodeString&)
    Set a Geometrical Expression for Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    o SetFormulaMotionPoint(CATUnicodeString&)
    Set a Geometrical Expression for Point of an Elementary Motion if ElementaryMotionType = GoToAPpoint.
    o SetHorizontalAngleValue(double&)
    Set the HorizontalAngleValue of an Elementary Motion if ElementaryMotionType = Horizontal.
    o SetHorizontalSafetyDistanceValue(double&)
    Set HorizontalSafetyDistanceValue of an Elementary Motion if ElementaryMotionType = Ramping.
    o SetInactive()
    Set an Elementary Motion to Inactive Status
  • o SetMotionDirectionVector(CATMathVector&)
    Set DirectionVector of an Elementary Motion if ElementaryMotionType = DeltaLnDist.
    o SetMotionPlane(CATBaseUnknown_var&)
    Set Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    o SetMotionPoint(CATBaseUnknown_var&)
    Set Point of an Elementary Motion if ElementaryMotionType = GoToAPpoint.
    o SetMotionToPlaneMode(int&)
    Set the way to move to the Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    o SetMotionToolAxis(CATMathVector&)
    Set DirectionVector of an Elementary Motion if ElementaryMotionType = ToolAxis.
    o SetRampingAngleValue(double&)
    Set RampingAngleValue of an Elementary Motion if ElementaryMotionType = Ramping.
    o SetSpindleSpeedType(int&)
    Set the SpindleSpeedType of an Elementary Motion.
    o SetSpindleSpeedValue(double&)
    Set the SpindleSpeedValue of an Elementary Motion if SpindleSpeedType = Local /Undefined Spindle Speed.
    o SetVerticalAngleValue(double&)
    Set the VerticalAngleValue of an Elementary Motion if ElementaryMotionType = Horizontal.
    o SetVerticalSafetyDistanceValue(double&)
    Set VerticalSafetyDistanceValue of an Elementary Motion if ElementaryMotionType = Ramping.

    Methods


    o AddPPWord
    public virtual AddPPWord( iCommandName)
    Add a PPWord.
    Parameters:
    iCommandName
    the word to add.
    o GetAngularOrientationValue
    public virtual GetAngularOrientationValue( oAngularOrientationValue)
    Read AngularOrientationValue from an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    oAngularOrientationValue
    The angular orientation value
    o GetAngularSectorValue
    public virtual GetAngularSectorValue( oAngularSectorValue)
    Read AngularSectorValue from an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    oAngularSectorValue
    The angular sector value
    o GetCircleRadiusValue
    public virtual GetCircleRadiusValue( oCircleRadiusValue)
    Read CircleRadiusValue from an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    oCircleRadiusValue
    The circle radius value
    o GetDistanceValue
    public virtual GetDistanceValue( oDistanceValue)
    Read a DistanceValue from an Elementary Motion if ElementaryMotionType = Horizontal or Axial or DeltaLnDist.
    Parameters:
    oDistanceValue
    The distance value
    o GetElementaryMotionType
    public virtual GetElementaryMotionType( oElementaryMotionType)
    Read the type of an Elementary Motion. The Horizontal type corresponds to Tangent and Normal types of Macro User Interface in the MO edit Panel.
    Parameters:
    oElementaryMotionType
    • 0:MfgMacroClearanceMotion
    • 1:MfgMacroElementaryAxialMotion
    • 2:MfgMacroElementaryHorizontalMotion
    • 3:MfgMacroElementaryCircularMotion
    • 4:MfgMacroPPWord
    • 5:MfgMacroElementaryRampingMotion
    • 6:MfgMacroElementaryGoToAPlaneMotion
    • 7:MfgMacroElementaryGoToAPointMotion
    • 8:MfgMacroElementaryDeltaLnDistMotion
    • 9:MfgMacroElementaryToolAxisMotion
    • 10:MfgMacroElementaryHelixMotion
    • 11:MfgMacroElementaryGoToALineMotion
    • 12:MfgMacroElementarySimultaneousAxisMotion
    o GetFeedrateType
    public virtual GetFeedrateType( oFeedrateType)
    Read a feedrateType From an Elementary Motion.
    Parameters:
    oFeedrateType
    • oFeedrateType (1:Machining Feedrate, 2:Approach Feedrate, 3:Retract Feedrate, 4:Rapid Feedrate, 5:Local - Undefined Feedrate, 6:Finishing, 7:Air Cutting)
    o GetFeedrateValue
    public virtual GetFeedrateValue( oFeedrate)
    Read a feedrateValue from an Elementary Motion if FeedrateType = Local /Undefined Feedrate/.
    Parameters:
    oFeedrate
    The feedrate value
    o GetHorizontalAngleValue
    public virtual GetHorizontalAngleValue( oHorizontalAngleValue)
    Read a HorizontalAngleValue from an Elementary Motion if ElementaryMotionType = Horizontal.
    Parameters:
    oHorizontalAngleValue
    The horizontal angle value
    o GetHorizontalSafetyDistanceValue
    public virtual GetHorizontalSafetyDistanceValue( oHorizontalDistanceValue)
    Read HorizontalSafetyDistanceValue from an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    oHorizontalDistanceValue
    The horizontal distance value
    o GetMotionDirectionVector
    public virtual GetMotionDirectionVector( oVector)
    Read DirectionVector from an Elementary Motion if ElementaryMotionType = DeltaLnDist.
    Parameters:
    oVector
    The direction vector
    o GetMotionPlane
    public virtual GetMotionPlane( oPlane)
    Read Plane from an Elementary Motion if ElementaryMotionType = GoToAPlane.
    Parameters:
    oPlane
    The plane
    o GetMotionPoint
    public virtual GetMotionPoint( oPoint)
    Read Point from an Elementary Motion if ElementaryMotionType = GoToAPpoint.
    Parameters:
    oPoint
    The point
    o GetMotionToPlaneMode
    public virtual GetMotionToPlaneMode( oMode)
    Read the way to move to the Plane from an Elementary Motion if ElementaryMotionType = GoToAPlane.
    Parameters:
    oMode
    • 0:perpendicular to the plane move
    • 1: axial move
    o GetMotionToolAxis
    public virtual GetMotionToolAxis( oVector)
    Read DirectionVector from an Elementary Motion if ElementaryMotionType = ToolAxis.
    Parameters:
    oVector
    The direction vector
    o GetNumberOfPPWord
    public virtual GetNumberOfPPWord()
    Get the number of PPWords..
    o GetPPWord
    public virtual GetPPWord( index,
    oPPWord)
    Get the index-st PPword.
    Parameters:
    index
    index of the wanted PPWord
    oPPWord
    Corresponding PPWord found
    o GetPPWordList
    public virtual GetPPWordList( oPPWordList)
    Read PPWordList from an Elementary Motion if ElementaryMotionType = PP.
    Parameters:
    oPPWordList
    The PP words list
    o GetRampingAngleValue
    public virtual GetRampingAngleValue( oRampingAngleValue)
    Read RampingAngleValue from an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    oRampingAngleValue
    The ramping angle value
    o GetSpindleSpeedType
    public virtual GetSpindleSpeedType( oSpindleSpeedType)
    Read a SpindleSpeedType from an Elementary Motion.
    Parameters:
    oSpindleSpeedType
    • (1: Machining 2:Approach, 3: Retract , 4: Rapid, 5:Local - Undefined Spindle Speed)
    o GetSpindleSpeedValue
    public virtual GetSpindleSpeedValue( oSpindle)
    Read a SpindleSpeedValue from an Elementary Motion if SpindleSpeedType = Local /Undefined Spindle Speed.
    Parameters:
    oSpindle
    The spindle spped value
    o GetVerticalAngleValue
    public virtual GetVerticalAngleValue( oVerticalAngleValue)
    Read a VerticalAngleValue from an Elementary Motion if ElementaryMotionType = Horizontal.
    Parameters:
    oVerticalAngleValue
    The vertical angle value
    o GetVerticalSafetyDistanceValue
    public virtual GetVerticalSafetyDistanceValue( oVerticalDistanceValue)
    Read VerticalSafetyDistanceValue from an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    oVerticalDistanceValue
    The vertical distance value
    o IsActive
    public virtual IsActive( oActive)
    Returns if an elementary motion is active or not.
    Parameters:
    oActive
    • 0:not active
    • 1:Active
    o RemovePPWord
    public virtual RemovePPWord()
    Remove all the PPWords.
    o SetActive
    public virtual SetActive()
    Set an Elementary Motion to Active Status
    • o SetAngularOrientationValue
    public virtual SetAngularOrientationValue( iAngularOrientationValue)
    Set AngularOrientationValue of an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    iAngularOrientationValue
    The angular orientation value
    o SetAngularSectorValue
    public virtual SetAngularSectorValue( iAngularSectorValue)
    Set AngularSectorValue of an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    iAngularSectorValue
    The angular sector value
    o SetCircleRadiusValue
    public virtual SetCircleRadiusValue( iCircleRadiusValue)
    Set CircleRadiusValue of an Elementary Motion if ElementaryMotionType = Circular.
    Parameters:
    iCircleRadiusValue
    The circle radius value
    o SetDistanceValue
    public virtual SetDistanceValue( iDistanceValue)
    Set the DistanceValue of an Elementary Motion if ElementaryMotionType = Horizontal or Axial or DeltaLnDist.
    Parameters:
    iDistanceValue
    The distance value
    o SetFeedrateType
    public virtual SetFeedrateType( iFeedrateType)
    Set the feedrateType of an Elementary Motion.
    Parameters:
    iFeedrateType
    • iFeedrateType (1:Machining Feedrate, 2:Approach Feedrate, 3:Retract Feedrate, 4:Rapid Feedrate, 5:Local - Undefined Feedrate, 6:Finishing, 7:Air Cutting)
    o SetFeedrateValue
    public virtual SetFeedrateValue( iFeedrate)
    Set feedrateValue of an Elementary Motion if FeedrateType = Local /Undefined Feedrate/.
    Parameters:
    iFeedrate
    The feedrate value
    o SetFormulaMotionPlane
    public virtual SetFormulaMotionPlane( const iExpression)
    Set a Geometrical Expression for Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    Parameters:
    iExpression
    Geometrical Expression to define.
    o SetFormulaMotionPoint
    public virtual SetFormulaMotionPoint( const iExpression)
    Set a Geometrical Expression for Point of an Elementary Motion if ElementaryMotionType = GoToAPpoint.
    Parameters:
    iExpression
    Geometrical Expression to define.
    o SetHorizontalAngleValue
    public virtual SetHorizontalAngleValue( iHorizontalAngleValue)
    Set the HorizontalAngleValue of an Elementary Motion if ElementaryMotionType = Horizontal.
    Parameters:
    iHorizontalAngleValue
    The horizontal angle value
    o SetHorizontalSafetyDistanceValue
    public virtual SetHorizontalSafetyDistanceValue( iHorizontalDistanceValue)
    Set HorizontalSafetyDistanceValue of an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    iHorizontalDistanceValue
    The horizontal distance value
    o SetInactive
    public virtual SetInactive()
    Set an Elementary Motion to Inactive Status
    • o SetMotionDirectionVector
    public virtual SetMotionDirectionVector( iVector)
    Set DirectionVector of an Elementary Motion if ElementaryMotionType = DeltaLnDist.
    Parameters:
    iVector
    The direction vector
    o SetMotionPlane
    public virtual SetMotionPlane( iPlane)
    Set Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    Parameters:
    iPlane
    The plane
    o SetMotionPoint
    public virtual SetMotionPoint( iPoint)
    Set Point of an Elementary Motion if ElementaryMotionType = GoToAPpoint.
    Parameters:
    iPoint
    The point
    o SetMotionToPlaneMode
    public virtual SetMotionToPlaneMode( iMode)
    Set the way to move to the Plane of an Elementary Motion if ElementaryMotionType = GoToAPlane.
    Parameters:
    iMode
    • 0:perpendicular to the plane move
    • 1: axial move
    o SetMotionToolAxis
    public virtual SetMotionToolAxis( iVector)
    Set DirectionVector of an Elementary Motion if ElementaryMotionType = ToolAxis.
    Parameters:
    iVector
    The direction vector
    o SetRampingAngleValue
    public virtual SetRampingAngleValue( iRampingAngleValue)
    Set RampingAngleValue of an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    iRampingAngleValue
    The ramping angle value
    o SetSpindleSpeedType
    public virtual SetSpindleSpeedType( iSpindleSpeedType)
    Set the SpindleSpeedType of an Elementary Motion.
    Parameters:
    iSpindleSpeedType
    • (1: Machining 2:Approach, 3: Retract , 4: Rapid, 5:Local - Undefined Spindle Speed)
    o SetSpindleSpeedValue
    public virtual SetSpindleSpeedValue( iSpindle)
    Set the SpindleSpeedValue of an Elementary Motion if SpindleSpeedType = Local /Undefined Spindle Speed.
    Parameters:
    iSpindle
    The spindle spped value
    o SetVerticalAngleValue
    public virtual SetVerticalAngleValue( iVerticalAngleValue)
    Set the VerticalAngleValue of an Elementary Motion if ElementaryMotionType = Horizontal.
    Parameters:
    iVerticalAngleValue
    The vertical angle value
    o SetVerticalSafetyDistanceValue
    public virtual SetVerticalSafetyDistanceValue( iVerticalDistanceValue)
    Set VerticalSafetyDistanceValue of an Elementary Motion if ElementaryMotionType = Ramping.
    Parameters:
    iVerticalDistanceValue
    The vertical distance value
    This object is included in the file: DELIMfgElementaryMotion.h
    If needed, your Imakefile.mk should include the module: MachiningUseItf

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