.. _package-rst-motioncontrol:

===========================
 Package rst.motioncontrol
===========================



This package contains data types for related to control of
articulated structures such as robotic manipulators.

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=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-motioncontrol.html#rst.motioncontrol.MotionStatusCollection" TITLE="Structure rst.motioncontrol.MotionStatusCollection" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">MotionStatusCollection</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-motioncontrol.html#rst.motioncontrol.MotionStatus" TITLE="Structure rst.motioncontrol.MotionStatus" TARGET="_parent">MotionStatus</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-motioncontrol.html#rst.motioncontrol.MotionStatusCollection.element" TITLE="Field rst.motioncontrol.MotionStatusCollection.element" TARGET="_parent" PORT="element">element</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-motioncontrol.html#rst.motioncontrol.MotionStatus" TITLE="Structure rst.motioncontrol.MotionStatus" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">MotionStatus</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-BOOL.html#BOOL" TITLE="Fundamental BOOL" TARGET="_parent">BOOL</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-motioncontrol.html#rst.motioncontrol.MotionStatus.converged" TITLE="Field rst.motioncontrol.MotionStatus.converged" TARGET="_parent" PORT="converged">converged</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "1":element -> "2" [];
         

   .. container:: mess4ge-list

      .. container:: messages

         * :ref:`MotionStatusCollection <message-rst-motioncontrol-motionstatuscollection>`
         * :ref:`MotionStatus <message-rst-motioncontrol-motionstatus>`

      .. container:: clearer

         clearer: should be made invisible via css

.. _message-rst-motioncontrol-motionstatuscollection:

Message MotionStatusCollection
------------------------------

.. container:: message-rst-motioncontrol-motionstatuscollection-multi

   .. container:: message-rst-motioncontrol-motionstatuscollection-documentation

      .. py:class:: rst.motioncontrol.MotionStatusCollection

         
         
         Collection of :py:class:`MotionStatus <rst.motioncontrol.MotionStatus>` instances.
         
         Auto-generated.

         .. py:attribute:: element

            :type: array of  :py:class:`rst.motioncontrol.MotionStatus`

            
            
            The individual elements of the collection.
            
            Constraints regarding the empty collection, sorting, duplicated
            entries etc. are use case specific.

   .. container:: message-rst-motioncontrol-motionstatuscollection-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/motioncontrol/MotionStatusCollection.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/motioncontrol/MotionStatusCollection.proto
         :lines: 12-22
         :language: protobuf
         :emphasize-lines: 9-9



.. _message-rst-motioncontrol-motionstatus:

Message MotionStatus
--------------------

.. container:: message-rst-motioncontrol-motionstatus-multi

   .. container:: message-rst-motioncontrol-motionstatus-documentation

      .. py:class:: rst.motioncontrol.MotionStatus

         
         
         Holds the status of a motion, one of the two:
         - Converged (in case of a periodic movement: following its attractor)
         - Not converged
         
         
         .. codeauthor:: Arne Nordmann <anordman@cor-lab.uni-bielefeld.de>
         
         @create_collection

         .. py:attribute:: converged

            :type: :py:class:`BOOL`

            
            
            Converged - true or false

   .. container:: message-rst-motioncontrol-motionstatus-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/motioncontrol/MotionStatus.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/motioncontrol/MotionStatus.proto
         :lines: 15-22
         :language: protobuf
         :emphasize-lines: 6-6