.. _package-rst-dynamics:
======================
Package rst.dynamics
======================
In the field of physics, the study of the causes of motion and
changes in motion is dynamics. In other words the study of forces
and why objects are in motion. Dynamics includes the study of the
effect of torques on motion.
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"]
"13" [label=< | JointTorquesCollection |
|
| JointTorques | element |
>,shape=box,style=filled,fillcolor="white"];
"14" [label=< | JointTorques |
|
| FLOAT32 | torques |
>,shape=box,style=filled,fillcolor="white"];
"12" [label=< | TorquesCollection |
|
| Torques | element |
>,shape=box,style=filled,fillcolor="white"];
"10" [label=< | PressuresCollection |
|
| Pressures | element |
>,shape=box,style=filled,fillcolor="white"];
"11" [label=< | Pressures |
|
| FLOAT64 | pressures |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | WrenchCollection |
|
| Wrench | element |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Wrench |
|
| Forces | forces |
| Torques | torques |
>,shape=box,style=filled,fillcolor="white"];
"9" [label=< | Torques |
|
| FLOAT32 | a |
| FLOAT32 | b |
| FLOAT32 | c |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | ForcesCollection |
|
| Forces | element |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Forces |
|
| FLOAT32 | x |
| FLOAT32 | y |
| FLOAT32 | z |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | MotorCurrentsCollection |
|
| MotorCurrents | element |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | MotorCurrents |
|
| FLOAT32 | currents |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | JointImpedanceCollection |
|
| JointImpedance | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | JointImpedance |
|
| FLOAT32 | stiffness |
| FLOAT32 | damping |
>,shape=box,style=filled,fillcolor="white"];
"13":element -> "14"[];
"12":element -> "9"[];
"10":element -> "11"[];
"7":element -> "8"[];
"8":torques -> "9"[];
"8":forces -> "6"[];
"5":element -> "6"[];
"3":element -> "4"[];
"1":element -> "2"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`JointImpedanceCollection `
* :ref:`MotorCurrentsCollection `
* :ref:`ForcesCollection `
* :ref:`WrenchCollection `
* :ref:`PressuresCollection `
* :ref:`TorquesCollection `
* :ref:`JointTorquesCollection `
* :ref:`JointImpedance `
* :ref:`MotorCurrents `
* :ref:`Wrench `
* :ref:`Forces `
* :ref:`Pressures `
* :ref:`Torques `
* :ref:`JointTorques `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-dynamics-jointimpedancecollection:
Message JointImpedanceCollection
--------------------------------
.. container:: message-rst-dynamics-jointimpedancecollection-multi
.. container:: message-rst-dynamics-jointimpedancecollection-documentation
.. py:class:: rst.dynamics.JointImpedanceCollection
Collection of :py:class:`JointImpedance ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.JointImpedance`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-jointimpedancecollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/JointImpedanceCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-motorcurrentscollection:
Message MotorCurrentsCollection
-------------------------------
.. container:: message-rst-dynamics-motorcurrentscollection-multi
.. container:: message-rst-dynamics-motorcurrentscollection-documentation
.. py:class:: rst.dynamics.MotorCurrentsCollection
Collection of :py:class:`MotorCurrents ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.MotorCurrents`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-motorcurrentscollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/MotorCurrentsCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-forcescollection:
Message ForcesCollection
------------------------
.. container:: message-rst-dynamics-forcescollection-multi
.. container:: message-rst-dynamics-forcescollection-documentation
.. py:class:: rst.dynamics.ForcesCollection
Collection of :py:class:`Forces ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.Forces`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-forcescollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/ForcesCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-wrenchcollection:
Message WrenchCollection
------------------------
.. container:: message-rst-dynamics-wrenchcollection-multi
.. container:: message-rst-dynamics-wrenchcollection-documentation
.. py:class:: rst.dynamics.WrenchCollection
Collection of :py:class:`Wrench ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.Wrench`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-wrenchcollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/WrenchCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-pressurescollection:
Message PressuresCollection
---------------------------
.. container:: message-rst-dynamics-pressurescollection-multi
.. container:: message-rst-dynamics-pressurescollection-documentation
.. py:class:: rst.dynamics.PressuresCollection
Collection of :py:class:`Pressures ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.Pressures`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-pressurescollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/PressuresCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-torquescollection:
Message TorquesCollection
-------------------------
.. container:: message-rst-dynamics-torquescollection-multi
.. container:: message-rst-dynamics-torquescollection-documentation
.. py:class:: rst.dynamics.TorquesCollection
Collection of :py:class:`Torques ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.Torques`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-torquescollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/TorquesCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-jointtorquescollection:
Message JointTorquesCollection
------------------------------
.. container:: message-rst-dynamics-jointtorquescollection-multi
.. container:: message-rst-dynamics-jointtorquescollection-documentation
.. py:class:: rst.dynamics.JointTorquesCollection
Collection of :py:class:`JointTorques ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.dynamics.JointTorques`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-dynamics-jointtorquescollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/JointTorquesCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-dynamics-jointimpedance:
Message JointImpedance
----------------------
.. container:: message-rst-dynamics-jointimpedance-multi
.. container:: message-rst-dynamics-jointimpedance-documentation
.. py:class:: rst.dynamics.JointImpedance
**Constraint**: ``len(.stiffness) == len(.damping)``
Stiffness and damping values of multiple joints.
.. codeauthor:: Christian Emmerich
.. todo::
what is SI unit of rotatory damping?
@create_collection
.. py:attribute:: stiffness
:type: array of :py:class:`FLOAT32`
**Unit**: TODO
Stiffness values of multiple joints.
(Same joints and same order as :py:attr:`damping `)
.. py:attribute:: damping
:type: array of :py:class:`FLOAT32`
Damping values of multiple joints
(Same joints and same order as :py:attr:`stiffness `)
@unit(newton-meter / rad)
.. container:: message-rst-dynamics-jointimpedance-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/JointImpedance.proto
:lines: 15-33
:language: protobuf
:emphasize-lines: 9-9,17-17
.. _message-rst-dynamics-motorcurrents:
Message MotorCurrents
---------------------
.. container:: message-rst-dynamics-motorcurrents-multi
.. container:: message-rst-dynamics-motorcurrents-documentation
.. py:class:: rst.dynamics.MotorCurrents
Represents measurements of motor currents for a robot's joints.
.. codeauthor:: Michael Wojtynek
@create_collection
.. py:attribute:: currents
:type: array of :py:class:`FLOAT32`
**Unit**: ampere
motor currents of the robot's drives
.. container:: message-rst-dynamics-motorcurrents-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/MotorCurrents.proto
:lines: 13-21
:language: protobuf
:emphasize-lines: 7-7
.. _message-rst-dynamics-wrench:
Message Wrench
--------------
.. container:: message-rst-dynamics-wrench-multi
.. container:: message-rst-dynamics-wrench-documentation
.. py:class:: rst.dynamics.Wrench
Interaction force, composed of Cartesian translational forces and Cartesian rotational forces.
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: forces
:type: :py:class:`rst.dynamics.Forces`
3-dimensional translatory forces.
.. py:attribute:: torques
:type: :py:class:`rst.dynamics.Torques`
3-dimensional rotatory forces (moment).
.. container:: message-rst-dynamics-wrench-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/Wrench.proto
:lines: 16-28
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-dynamics-forces:
Message Forces
--------------
.. container:: message-rst-dynamics-forces-multi
.. container:: message-rst-dynamics-forces-documentation
.. py:class:: rst.dynamics.Forces
Cartesian 3-dimensional translatory force.
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: x
:type: :py:class:`FLOAT32`
**Unit**: newton
Translatory force along the x axis.
.. py:attribute:: y
:type: :py:class:`FLOAT32`
**Unit**: newton
Translatory force along the y axis.
.. py:attribute:: z
:type: :py:class:`FLOAT32`
**Unit**: newton
Translatory force along the z axis.
.. container:: message-rst-dynamics-forces-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/Forces.proto
:lines: 13-33
:language: protobuf
:emphasize-lines: 7-7,13-13,19-19
.. _message-rst-dynamics-pressures:
Message Pressures
-----------------
.. container:: message-rst-dynamics-pressures-multi
.. container:: message-rst-dynamics-pressures-documentation
.. py:class:: rst.dynamics.Pressures
A sequence of pressure measurements (e.g. in pneumatic systems).
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: pressures
:type: array of :py:class:`FLOAT64`
**Unit**: pascal
.. container:: message-rst-dynamics-pressures-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/Pressures.proto
:lines: 13-18
:language: protobuf
:emphasize-lines: 4-4
.. _message-rst-dynamics-torques:
Message Torques
---------------
.. container:: message-rst-dynamics-torques-multi
.. container:: message-rst-dynamics-torques-documentation
.. py:class:: rst.dynamics.Torques
Cartesian 3-dimensional rotational force (moment).
To specify torques in joint space, use :py:class:`JointTorques ` instead.
.. codeauthor:: Arne Nordmann
.. todo::
can we be more specific about the axes here?
@create_collection
.. py:attribute:: a
:type: :py:class:`FLOAT32`
**Unit**: newton-meter
Torque around the x axis.
.. py:attribute:: b
:type: :py:class:`FLOAT32`
**Unit**: newton-meter
Torque around the y axis.
.. py:attribute:: c
:type: :py:class:`FLOAT32`
**Unit**: newton-meter
Torque around the z axis.
.. container:: message-rst-dynamics-torques-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/Torques.proto
:lines: 17-37
:language: protobuf
:emphasize-lines: 7-7,13-13,19-19
.. _message-rst-dynamics-jointtorques:
Message JointTorques
--------------------
.. container:: message-rst-dynamics-jointtorques-multi
.. container:: message-rst-dynamics-jointtorques-documentation
.. py:class:: rst.dynamics.JointTorques
A sequence of joint torques of multiple joints.
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: torques
:type: array of :py:class:`FLOAT32`
**Unit**: newton-meter
List of torques with one value per joint. Order is important and
represents the joints of the described system.
.. container:: message-rst-dynamics-jointtorques-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/dynamics/JointTorques.proto
:lines: 13-22
:language: protobuf
:emphasize-lines: 8-8