.. _package-rst-hri:
=================
Package rst.hri
=================
Human–robot interaction is the study of interactions between humans
and robots. It is often referred as HRI by researchers.
This package contains data type definitions related to human-robot
interaction.
.. seealso::
Wikipedia article containing the definition above
http://en.wikipedia.org/wiki/Human-robot_interaction
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/corlab.css";
node [fontsize=11]
node [fontname="Arial"]
edge [fontsize=11]
edge [fontname="Arial"]
"1" [label=< | LegsList |
|
| Legs | list |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | Legs |
|
| FLOAT32 | angle |
| FLOAT32 | angle_variance |
| FLOAT32 | distance |
| FLOAT32 | distance_variance |
| BOOL | pair |
>,shape=box,style=filled,fillcolor="white"];
"1":list -> "2" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`LegsList `
* :ref:`Legs `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-hri-legslist:
Message LegsList
----------------
.. container:: message-rst-hri-legslist-multi
.. container:: message-rst-hri-legslist-documentation
.. py:class:: rst.hri.LegsList
A collection of .
.. codeauthor:: Phillip Luecking
.. py:attribute:: list
:type: array of :py:class:`rst.hri.Legs`
Empty collection of legs is allowed.
The order of leg objects is not significant.
.. container:: message-rst-hri-legslist-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.11-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/hri/LegsList.proto
:lines: 12-20
:language: protobuf
:emphasize-lines: 7-7
.. _message-rst-hri-legs:
Message Legs
------------
.. container:: message-rst-hri-legs-multi
.. container:: message-rst-hri-legs-documentation
.. py:class:: rst.hri.Legs
A representation of a pair of legs (or a single leg).
The :py:attr:`pair ` field indicates whether this object has been merged
with another object of the same type into a representation of a
pair of legs.
The values stored in :py:attr:`angle ` and :py:attr:`distance ` are as
perceived from the robot.
.. codeauthor:: Phillip Luecking
.. py:attribute:: angle
:type: :py:class:`FLOAT32`
**Unit**: radian
The angle of the leg(s) as perceived by the robot's sensor.
.. py:attribute:: angle_variance
:type: :py:class:`FLOAT32`
**Unit**: radian
The variance of the :py:attr:`angle `.
.. py:attribute:: distance
:type: :py:class:`FLOAT32`
**Unit**: meter
The distance between the robot's sensor and the leg(s).
.. py:attribute:: distance_variance
:type: :py:class:`FLOAT32`
**Unit**: meter
The variance of the :py:attr:`distance `.
.. py:attribute:: pair
:type: :py:class:`BOOL`
Indicates whether or not this object consists of two merged Legs.
If true, merging is no longer possible.
.. container:: message-rst-hri-legs-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.11-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/hri/Legs.proto
:lines: 17-50
:language: protobuf
:emphasize-lines: 7-7,13-13,19-19,25-25,32-32