KDL  1.4.0
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
KDL::Path_Cyclic_Closed Class Reference

A Path representing a closed circular movement, which is traversed a number of times. More...

#include <src/path_cyclic_closed.hpp>

Inheritance diagram for KDL::Path_Cyclic_Closed:
Inheritance graph
[legend]
Collaboration diagram for KDL::Path_Cyclic_Closed:
Collaboration graph
[legend]

Public Types

enum  IdentifierType {
  ID_LINE =1, ID_CIRCLE =2, ID_COMPOSITE =3, ID_ROUNDED_COMPOSITE =4,
  ID_POINT =5, ID_CYCLIC_CLOSED =6
}
 

Public Member Functions

 Path_Cyclic_Closed (Path *_geom, int _times, bool _aggregate=true)
 
virtual double LengthToS (double length)
 LengthToS() converts a physical length along the trajectory to the parameter s used in Pos, Vel and Acc. More...
 
virtual double PathLength ()
 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. More...
 
virtual Frame Pos (double s) const
 Returns the Frame at the current path length s. More...
 
virtual Twist Vel (double s, double sd) const
 Returns the velocity twist at path length s theta and with derivative of s == sd. More...
 
virtual Twist Acc (double s, double sd, double sdd) const
 Returns the acceleration twist at path length s and with derivative of s == sd, and 2nd derivative of s == sdd. More...
 
virtual void Write (std::ostream &os)
 Writes one of the derived objects to the stream. More...
 
virtual PathClone ()
 Virtual constructor, constructing by copying, Returns a deep copy of this Path Object. More...
 
virtual IdentifierType getIdentifier () const
 gets an identifier indicating the type of this Path object More...
 
virtual ~Path_Cyclic_Closed ()
 

Static Public Member Functions

static PathRead (std::istream &is)
 

Private Attributes

int times
 
Pathgeom
 
bool aggregate
 

Detailed Description

A Path representing a closed circular movement, which is traversed a number of times.

Member Enumeration Documentation

§ IdentifierType

enum KDL::Path::IdentifierType
inherited
Enumerator
ID_LINE 
ID_CIRCLE 
ID_COMPOSITE 
ID_ROUNDED_COMPOSITE 
ID_POINT 
ID_CYCLIC_CLOSED 

Constructor & Destructor Documentation

§ Path_Cyclic_Closed()

KDL::Path_Cyclic_Closed::Path_Cyclic_Closed ( Path _geom,
int  _times,
bool  _aggregate = true 
)

Referenced by Clone().

§ ~Path_Cyclic_Closed()

KDL::Path_Cyclic_Closed::~Path_Cyclic_Closed ( )
virtual

References aggregate, and geom.

Referenced by getIdentifier().

Member Function Documentation

§ Acc()

Twist KDL::Path_Cyclic_Closed::Acc ( double  s,
double  sd,
double  sdd 
) const
virtual

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

Implements KDL::Path.

References KDL::Path::Acc(), geom, and KDL::Path::PathLength().

§ Clone()

Path * KDL::Path_Cyclic_Closed::Clone ( )
virtual

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

Implements KDL::Path.

References aggregate, KDL::Path::Clone(), geom, Path_Cyclic_Closed(), and times.

§ getIdentifier()

virtual IdentifierType KDL::Path_Cyclic_Closed::getIdentifier ( ) const
inlinevirtual

gets an identifier indicating the type of this Path object

Implements KDL::Path.

References KDL::Path::ID_CYCLIC_CLOSED, and ~Path_Cyclic_Closed().

§ LengthToS()

double KDL::Path_Cyclic_Closed::LengthToS ( double  length)
virtual

LengthToS() converts a physical length along the trajectory to the parameter s used in Pos, Vel and Acc.

This is used because in cases with large rotations the parameter s does NOT correspond to the lineair length along the trajectory. User should be sure that the lineair distance travelled by this path object is NOT zero, when using this method ! (e.g. the case of only rotational change) throws Error_MotionPlanning_Not_Applicable if used on composed path objects.

Implements KDL::Path.

§ PathLength()

double KDL::Path_Cyclic_Closed::PathLength ( )
virtual

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.

Implements KDL::Path.

References geom, KDL::Path::PathLength(), and times.

§ Pos()

Frame KDL::Path_Cyclic_Closed::Pos ( double  s) const
virtual

Returns the Frame at the current path length s.

Implements KDL::Path.

References geom, KDL::Path::PathLength(), and KDL::Path::Pos().

§ Read()

static Path* KDL::Path_Cyclic_Closed::Read ( std::istream &  is)
static

§ Vel()

Twist KDL::Path_Cyclic_Closed::Vel ( double  s,
double  sd 
) const
virtual

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

Implements KDL::Path.

References geom, KDL::Path::PathLength(), and KDL::Path::Vel().

§ Write()

void KDL::Path_Cyclic_Closed::Write ( std::ostream &  os)
virtual

Writes one of the derived objects to the stream.

Implements KDL::Path.

References geom, times, and KDL::Path::Write().

Member Data Documentation

§ aggregate

bool KDL::Path_Cyclic_Closed::aggregate
private

Referenced by Clone(), and ~Path_Cyclic_Closed().

§ geom

Path* KDL::Path_Cyclic_Closed::geom
private

§ times

int KDL::Path_Cyclic_Closed::times
private

Referenced by Clone(), PathLength(), and Write().


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