All Frameworks  Class Hierarchy  This Framework  Indexes   

ManufacturingInterfaces Interface CATIMfgActivityElementaryMotion

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


interface CATIMfgActivityElementaryMotion

Interface dedicated to manage elementary macro motion.
Role: This interface offers services to access datas from elementary motion.


Method Index


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 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 a elementary motion is active or not.

Methods


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
  • 1:Axial
  • 2:Horizontal
  • 3:Circular
  • 4:PP
  • 5:Ramping
  • 6:GoToAPlane
  • 7:GoToPt
  • 8:DeltaLnDist
  • 9:ToolAxis
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 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 a elementary motion is active or not.
Parameters:
oActive
  • 0:not active
  • 1:Active

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

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