.. _package-rst-devices-flexirob:
==============================
Package rst.devices.flexirob
==============================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=< | RobotStateCollection |
|
| RobotState | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | RobotState |
|
| ConnectionStatus | connection |
| MotionStatus | motion |
| ForceStatus | forces |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | ForceStatus |
|
| CONSTANT | 1 |
| CHANGING | 2 |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | MotionStatus |
|
| CONVERGED | 1 |
| MOVING | 2 |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | ConnectionStatus |
|
| CONNECTED | 1 |
| NOT_CONNECTED | 2 |
>,shape=box,style=filled,fillcolor="white"];
"1":element -> "2" [];
"2" -> "5" [];
"2" -> "4" [];
"2" -> "3" [];
"2":forces -> "5" [];
"2":motion -> "4" [];
"2":connection -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`RobotStateCollection `
* :ref:`RobotState `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-devices-flexirob-robotstatecollection:
Message RobotStateCollection
----------------------------
.. container:: message-rst-devices-flexirob-robotstatecollection-multi
.. container:: message-rst-devices-flexirob-robotstatecollection-documentation
.. py:class:: rst.devices.flexirob.RobotStateCollection
Collection of :py:class:`RobotState ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.devices.flexirob.RobotState`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-devices-flexirob-robotstatecollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/sandbox/rst/devices/flexirob/RobotStateCollection.proto
:lines: 12-22
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-devices-flexirob-robotstate:
Message RobotState
------------------
.. container:: message-rst-devices-flexirob-robotstate-multi
.. container:: message-rst-devices-flexirob-robotstate-documentation
.. py:class:: rst.devices.flexirob.RobotState
Holds information about a robot's global state.
.. codeauthor:: Christian Emmerich
@create_collection
.. py:attribute:: connection
:type: :py:class:`rst.devices.flexirob.RobotState.ConnectionStatus`
*Not documented*
.. py:attribute:: motion
:type: :py:class:`rst.devices.flexirob.RobotState.MotionStatus`
*Not documented*
.. py:attribute:: forces
:type: :py:class:`rst.devices.flexirob.RobotState.ForceStatus`
*Not documented*
.. container:: message-rst-devices-flexirob-robotstate-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/sandbox/rst/devices/flexirob/RobotState.proto
:lines: 13-54
:language: protobuf
:emphasize-lines: 14-14,27-27,40-40
.. _message-rst-devices-flexirob-robotstate-connectionstatus:
Message ConnectionStatus
------------------------
.. container:: message-rst-devices-flexirob-robotstate-connectionstatus-multi
.. container:: message-rst-devices-flexirob-robotstate-connectionstatus-documentation
.. py:class:: rst.devices.flexirob.RobotState.ConnectionStatus
Possible connection states.
.. py:attribute:: CONNECTED
= 1
*Not documented*
.. py:attribute:: NOT_CONNECTED
= 2
*Not documented*
.. container:: message-rst-devices-flexirob-robotstate-connectionstatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/sandbox/rst/devices/flexirob/RobotState.proto
:lines: 18-24
:language: protobuf
:emphasize-lines: 3-3,5-5
.. _message-rst-devices-flexirob-robotstate-motionstatus:
Message MotionStatus
--------------------
.. container:: message-rst-devices-flexirob-robotstate-motionstatus-multi
.. container:: message-rst-devices-flexirob-robotstate-motionstatus-documentation
.. py:class:: rst.devices.flexirob.RobotState.MotionStatus
Possible states of motion.
.. py:attribute:: CONVERGED
= 1
*Not documented*
.. py:attribute:: MOVING
= 2
*Not documented*
.. container:: message-rst-devices-flexirob-robotstate-motionstatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/sandbox/rst/devices/flexirob/RobotState.proto
:lines: 31-37
:language: protobuf
:emphasize-lines: 3-3,5-5
.. _message-rst-devices-flexirob-robotstate-forcestatus:
Message ForceStatus
-------------------
.. container:: message-rst-devices-flexirob-robotstate-forcestatus-multi
.. container:: message-rst-devices-flexirob-robotstate-forcestatus-documentation
.. py:class:: rst.devices.flexirob.RobotState.ForceStatus
Possible force sensing states.
.. py:attribute:: CONSTANT
= 1
*Not documented*
.. py:attribute:: CHANGING
= 2
*Not documented*
.. container:: message-rst-devices-flexirob-robotstate-forcestatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/sandbox/rst/devices/flexirob/RobotState.proto
:lines: 44-50
:language: protobuf
:emphasize-lines: 3-3,5-5