Commit fd183e3a authored by florent's avatar florent Committed by florent
Browse files

Move hppCore.h into package.h in doc/additionalDoc.

	* doc/additionalDoc/hppCore.h,
	* doc/additionalDoc/package.h.
parent 24cd115e
/** \mainpage
\section hppCore_sec_intro Introduction
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.
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
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.
*/
......@@ -3,10 +3,15 @@
This package implements basic classes used as interfaces with KineoWorks.
The main classes are:
\li ChppDevice: implement a humanoid robot with a dynamical model.
\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.
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.
......
Markdown is supported
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