KDL::Path Class Reference

The specification of the path of a trajectory. More...

#include <path.hpp>

Inheritance diagram for KDL::Path:
KDL::Path_Circle KDL::Path_Composite KDL::Path_Cyclic_Closed KDL::Path_Line KDL::Path_Point KDL::Path_RoundedComposite

List of all members.

Public Member Functions

virtual Twist Acc (double s, double sd, double sdd) const =0
 Returns the acceleration twist at path length s and with derivative of s == sd, and 2nd derivative of s == sdd.
virtual PathClone ()=0
 Virtual constructor, constructing by copying, Returns a deep copy of this Path Object.
virtual double LengthToS (double length)=0
 LengthToS() converts a physical length along the trajectory to the parameter s used in Pos, Vel and Acc.
virtual double PathLength ()=0
 Returns the total path length of the trajectory (has dimension LENGTH) This is not always a physical length , ie when dealing with rotations that are dominant.
virtual Frame Pos (double s) const =0
 Returns the Frame at the current path length s.
virtual Twist Vel (double s, double sd) const =0
 Returns the velocity twist at path length s theta and with derivative of s == sd.
virtual void Write (std::ostream &os)=0
 Writes one of the derived objects to the stream.
virtual ~Path ()

Static Public Member Functions

static PathRead (std::istream &is)
 Reads one of the derived objects from the stream and returns a pointer (factory method).

Detailed Description

The specification of the path of a trajectory.

Definition at line 58 of file path.hpp.


Constructor & Destructor Documentation

virtual KDL::Path::~Path (  )  [inline, virtual]

Definition at line 118 of file path.hpp.


Member Function Documentation

virtual Twist KDL::Path::Acc ( double  s,
double  sd,
double  sdd 
) const [pure virtual]

Returns the acceleration twist at path length s and with derivative of s == sd, and 2nd derivative of s == sdd.

Implemented in KDL::Path_Circle, KDL::Path_Composite, KDL::Path_Cyclic_Closed, KDL::Path_Line, KDL::Path_Point, and KDL::Path_RoundedComposite.

Referenced by KDL::Trajectory_Segment::Acc(), and KDL::Path_Cyclic_Closed::Acc().

virtual Path* KDL::Path::Clone (  )  [pure virtual]

Virtual constructor, constructing by copying, Returns a deep copy of this Path Object.

Implemented in KDL::Path_Circle, KDL::Path_Composite, KDL::Path_Cyclic_Closed, KDL::Path_Line, KDL::Path_Point, and KDL::Path_RoundedComposite.

Referenced by KDL::Trajectory_Segment::Clone(), and KDL::Path_Cyclic_Closed::Clone().

virtual double KDL::Path::PathLength (  )  [pure virtual]
virtual Frame KDL::Path::Pos ( double  s  )  const [pure virtual]
Path * KDL::Path::Read ( std::istream &  is  )  [static]

Reads one of the derived objects from the stream and returns a pointer (factory method).

Reimplemented in KDL::Path_Cyclic_Closed.

Definition at line 61 of file path.cpp.

References KDL::deg2rad, KDL::Eat(), KDL::EatEnd(), KDL::EatWord(), SketcherExample::f, KDL::IOTrace(), KDL::IOTracePop(), and KDL::RotationalInterpolation::Read().

Referenced by KDL::Trajectory::Read().

virtual Twist KDL::Path::Vel ( double  s,
double  sd 
) const [pure virtual]

Returns the velocity twist at path length s theta and with derivative of s == sd.

Implemented in KDL::Path_Circle, KDL::Path_Composite, KDL::Path_Cyclic_Closed, KDL::Path_Line, KDL::Path_Point, and KDL::Path_RoundedComposite.

Referenced by KDL::Trajectory_Segment::Vel(), and KDL::Path_Cyclic_Closed::Vel().

virtual void KDL::Path::Write ( std::ostream &  os  )  [pure virtual]

The documentation for this class was generated from the following files:

Generated on Wed Nov 23 19:02:18 2011 for FreeCAD by  doxygen 1.6.1