~shadowrobot/sr-ros-interface/stable

« back to all changes in this revision

Viewing changes to shadow_robot/sr_tactile_sensors/mainpage.dox

  • Committer: Ugo Cupcic
  • Date: 2011-11-21 16:31:23 UTC
  • mfrom: (1.1.164 sr-ros-interface)
  • Revision ID: ugo@shadowrobot.com-20111121163123-k5q6e8l00w81f5hx
0.1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/**
 
2
\mainpage
 
3
\htmlinclude manifest.html
 
4
 
 
5
\b This package contains an interface to the tactile sensors used in our Dexterous Hand. The tactile sensors are - for the time being - simple pressure sensors, one on each finger tip, but they will evolve to more complex tactile sensors.
 
6
 
 
7
<!--
 
8
Provide an overview of your package.
 
9
-->
 
10
 
 
11
 
 
12
\section codeapi Code API
 
13
The shadowrobot::SrTactileSensorManager contains a vector of shadowrobot::SrGenericTactileSensor. The goal of the manager is to load the sensors parameters and call each publish functions of the sensor.
 
14
 
 
15
Those two classes are then derivated for the Virtual / Gazebo and Real sensors.
 
16
<!--
 
17
Provide links to specific auto-generated API documentation within your
 
18
package that is of particular interest to a reader. Doxygen will
 
19
document pretty much every part of your code, so do your best here to
 
20
point the reader to the actual API.
 
21
 
 
22
If your codebase is fairly large or has different sets of APIs, you
 
23
should use the doxygen 'group' tag to keep these APIs together. For
 
24
example, the roscpp documentation has 'libros' group.
 
25
-->
 
26
 
 
27
 
 
28
*/