ompl::base::Path Class Reference

Abstract definition of a path. More...

#include <Path.h>

Inheritance diagram for ompl::base::Path:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool check (void) const =0
 Check if the path is valid.
const SpaceInformationPtrgetSpaceInformation (void) const
 Get the space information associated to this class.
virtual double length (void) const =0
 Return the length of a path.
 Path (const SpaceInformationPtr &si)
 Constructor. A path must always know the space information it is part of.
virtual void print (std::ostream &out) const =0
 Print the path to a stream.
virtual ~Path (void)
 Destructor.

Protected Attributes

SpaceInformationPtr si_
 The space information this path is part of.

Detailed Description

Abstract definition of a path.

Definition at line 59 of file Path.h.


Constructor & Destructor Documentation

ompl::base::Path::Path ( const SpaceInformationPtr si  )  [inline]

Constructor. A path must always know the space information it is part of.

Definition at line 64 of file Path.h.

virtual ompl::base::Path::~Path ( void   )  [inline, virtual]

Destructor.

Definition at line 69 of file Path.h.


Member Function Documentation

virtual bool ompl::base::Path::check ( void   )  const [pure virtual]

Check if the path is valid.

Implemented in ompl::control::PathControl, and ompl::geometric::PathGeometric.

const SpaceInformationPtr& ompl::base::Path::getSpaceInformation ( void   )  const [inline]

Get the space information associated to this class.

Definition at line 74 of file Path.h.

virtual double ompl::base::Path::length ( void   )  const [pure virtual]

Return the length of a path.

Implemented in ompl::control::PathControl, and ompl::geometric::PathGeometric.

virtual void ompl::base::Path::print ( std::ostream &  out  )  const [pure virtual]

Print the path to a stream.

Implemented in ompl::control::PathControl, and ompl::geometric::PathGeometric.


Member Data Documentation

The space information this path is part of.

Definition at line 91 of file Path.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:33:59 2013