.. _package-rst-timing:

====================
 Package rst.timing
====================



This package contains data types which represent aspects of time.

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=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-timing.html#rst.timing.Interval" TITLE="Structure rst.timing.Interval" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">Interval</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-timing.html#rst.timing.Timestamp" TITLE="Structure rst.timing.Timestamp" TARGET="_parent">Timestamp</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-timing.html#rst.timing.Interval.begin" TITLE="Field rst.timing.Interval.begin" TARGET="_parent" PORT="begin">begin</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-timing.html#rst.timing.Timestamp" TITLE="Structure rst.timing.Timestamp" TARGET="_parent">Timestamp</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-timing.html#rst.timing.Interval.end" TITLE="Field rst.timing.Interval.end" TARGET="_parent" PORT="end">end</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-timing.html#rst.timing.Timestamp" TITLE="Structure rst.timing.Timestamp" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">Timestamp</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-timing.html#rst.timing.Timestamp.time" TITLE="Field rst.timing.Timestamp.time" TARGET="_parent" PORT="time">time</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
           "1":end -> "2" [];
           "1":begin -> "2" [];
         

   .. container:: mess4ge-list

      .. container:: messages

         * :ref:`Interval <message-rst-timing-interval>`
         * :ref:`Timestamp <message-rst-timing-timestamp>`

      .. container:: clearer

         clearer: should be made invisible via css

.. _message-rst-timing-interval:

Message Interval
----------------

.. container:: message-rst-timing-interval-multi

   .. container:: message-rst-timing-interval-documentation

      .. py:class:: rst.timing.Interval

         **Constraint**: ``.begin.time <= .end.time``
         
         
         
         A time interval represented with two absolute timestamps.
         
         
         .. codeauthor:: Arne Nordmann <anordman@techfak.uni-bielefeld.de>
         
         

         .. py:attribute:: begin

            :type: :py:class:`rst.timing.Timestamp`

            
            
            Start of the interval.

         .. py:attribute:: end

            :type: :py:class:`rst.timing.Timestamp`

            
            
            End of the interval.

   .. container:: message-rst-timing-interval-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/timing/Interval.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/timing/Interval.proto
         :lines: 13-25
         :language: protobuf
         :emphasize-lines: 6-6,11-11



.. _message-rst-timing-timestamp:

Message Timestamp
-----------------

.. container:: message-rst-timing-timestamp-multi

   .. container:: message-rst-timing-timestamp-documentation

      .. py:class:: rst.timing.Timestamp

         
         
         Holds a UNIX timestamp in microseconds.
         
         Count starts at the Unix Epoch on January 1st, 1970 in UTC time.
         
         
         .. codeauthor:: Agnes Swadzba <aswadzba@techfak.uni-bielefeld.de>
         

         .. py:attribute:: time

            :type: :py:class:`UINT64`

            **Unit**: microsecond
            
            
            
            Number of microseconds since January 1st, 1970 in UTC time.
            

   .. container:: message-rst-timing-timestamp-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/timing/Timestamp.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/timing/Timestamp.proto
         :lines: 12-20
         :language: protobuf
         :emphasize-lines: 7-7