Commit e5c85511 authored by Florent Lamiraux's avatar Florent Lamiraux Committed by Florent Lamiraux florent@laas.fr
Browse files

Fix documentation.

parent e2f42a73
......@@ -3,20 +3,14 @@
This package implements basic classes used as interfaces with KineoWorks.
The main classes are:
\li ChppProblem: define a canonical path planning problem.
\li ChppPlanner: contains a vector of above path planning problems to implement iterative planning algorithms that use several instaciations of a robot.
Depending on configuration, classes
\li ChppDevice implementing a robot and
\li ChppBody implementing a robot body
are defined locally or in hppModel package.
\li hpp::core::Problem: define a canonical path planning problem.
\li hpp::core::Planner: contains a vector of above path planning problems to implement iterative planning algorithms that use several instaciations of a robot.
This package and depending packages implementing algorithms can be
used with or without GUI, depending on whether we are developing and
debugging new algorithms or we want to run the algorithms on-board a robot.
Upon some events (a problem is added in ChppPlanner object, a path has been planned, ...), notifications are
Upon some events (a problem is added in hpp::core::Planner object, a path has been planned, ...), notifications are
sent.
\li When working with the GUI, these notification are caught by the interface and objects are added in the view,
\li when working without interface, the notification have no effet.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment