.. _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/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"9" [label=< | Point2DTimeseries |
|
| Point2DTimestampPair | entry |
>,shape=box,style=filled,fillcolor="white"];
"10" [label=< | Point2DTimestampPair |
|
| Vec2DFloat | point |
| Timestamp | timestamp |
>,shape=box,style=filled,fillcolor="white"];
"11" [label=< | Vec2DFloat |
|
| FLOAT32 | x |
| FLOAT32 | y |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | FrequencyCollection |
|
| Frequency | element |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Frequency |
|
| FLOAT64 | hz |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | DurationCollection |
|
| Duration | element |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Duration |
|
| UINT64 | time |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | TimestampCollection |
|
| Timestamp | element |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | IntervalCollection |
|
| Interval | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | Interval |
|
| Timestamp | begin |
| Timestamp | end |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Timestamp |
|
| UINT64 | time |
>,shape=box,style=filled,fillcolor="white"];
"9":entry -> "10"[];
"10":timestamp -> "3"[];
"10":point -> "11"[];
"7":element -> "8"[];
"5":element -> "6"[];
"4":element -> "3"[];
"1":element -> "2"[];
"2":end -> "3"[];
"2":begin -> "3"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`IntervalCollection `
* :ref:`TimestampCollection `
* :ref:`DurationCollection `
* :ref:`FrequencyCollection `
* :ref:`Interval `
* :ref:`Duration `
* :ref:`Point2DTimeseries `
* :ref:`Point2DTimestampPair `
* :ref:`Timestamp `
* :ref:`Frequency `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-timing-intervalcollection:
Message IntervalCollection
--------------------------
.. container:: message-rst-timing-intervalcollection-multi
.. container:: message-rst-timing-intervalcollection-documentation
.. py:class:: rst.timing.IntervalCollection
Collection of :py:class:`Interval ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.timing.Interval`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-timing-intervalcollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/IntervalCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-timing-timestampcollection:
Message TimestampCollection
---------------------------
.. container:: message-rst-timing-timestampcollection-multi
.. container:: message-rst-timing-timestampcollection-documentation
.. py:class:: rst.timing.TimestampCollection
Collection of :py:class:`Timestamp ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.timing.Timestamp`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-timing-timestampcollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/TimestampCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-timing-durationcollection:
Message DurationCollection
--------------------------
.. container:: message-rst-timing-durationcollection-multi
.. container:: message-rst-timing-durationcollection-documentation
.. py:class:: rst.timing.DurationCollection
Collection of :py:class:`Duration ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.timing.Duration`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-timing-durationcollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/DurationCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-timing-frequencycollection:
Message FrequencyCollection
---------------------------
.. container:: message-rst-timing-frequencycollection-multi
.. container:: message-rst-timing-frequencycollection-documentation
.. py:class:: rst.timing.FrequencyCollection
Collection of :py:class:`Frequency ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.timing.Frequency`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-timing-frequencycollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/FrequencyCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _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
@create_collection
.. 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 `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Interval.proto
:lines: 16-28
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-timing-duration:
Message Duration
----------------
.. container:: message-rst-timing-duration-multi
.. container:: message-rst-timing-duration-documentation
.. py:class:: rst.timing.Duration
Holds a time duration in microseconds.
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: time
:type: :py:class:`UINT64`
**Unit**: microsecond
.. container:: message-rst-timing-duration-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Duration.proto
:lines: 13-18
:language: protobuf
:emphasize-lines: 4-4
.. _message-rst-timing-point2dtimeseries:
Message Point2DTimeseries
-------------------------
.. container:: message-rst-timing-point2dtimeseries-multi
.. container:: message-rst-timing-point2dtimeseries-documentation
.. py:class:: rst.timing.Point2DTimeseries
An ordered list of pairs each consisting of a timestamp and a 2D point.
.. codeauthor:: Agnes Swadzba
.. py:attribute:: entry
:type: array of :py:class:`rst.timing.Point2DTimestampPair`
**Constraint**: ``for i from 0 below (len(value) - 1) value[i].timestamp.time < value[i+1].timestamp.time end``
Entries are sorted in increasing order of the :py:attr:`timestamp ` field.
.. container:: message-rst-timing-point2dtimeseries-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Point2DTimeseries.proto
:lines: 14-23
:language: protobuf
:emphasize-lines: 8-8
.. _message-rst-timing-point2dtimestamppair:
Message Point2DTimestampPair
----------------------------
.. container:: message-rst-timing-point2dtimestamppair-multi
.. container:: message-rst-timing-point2dtimestamppair-documentation
.. py:class:: rst.timing.Point2DTimestampPair
A pair assembled from a 2D Point and a timestamp.
.. codeauthor:: Agnes Swadzba
.. py:attribute:: point
:type: :py:class:`rst.math.Vec2DFloat`
The point associated to the timestamp.
.. py:attribute:: timestamp
:type: :py:class:`rst.timing.Timestamp`
The timestamp associate to the point.
.. container:: message-rst-timing-point2dtimestamppair-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Point2DTimestampPair.proto
:lines: 15-27
: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
@create_collection
.. 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 `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Timestamp.proto
:lines: 15-23
:language: protobuf
:emphasize-lines: 7-7
.. _message-rst-timing-frequency:
Message Frequency
-----------------
.. container:: message-rst-timing-frequency-multi
.. container:: message-rst-timing-frequency-documentation
.. py:class:: rst.timing.Frequency
Holds a frequency.
.. codeauthor:: Arne Nordmann
@create_collection
.. py:attribute:: hz
:type: :py:class:`FLOAT64`
**Unit**: hertz
.. container:: message-rst-timing-frequency-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/timing/Frequency.proto
:lines: 13-18
:language: protobuf
:emphasize-lines: 4-4