.. _package-rst-generic:
=====================
Package rst.generic
=====================
Message which are capable of handling dynamic data types.
This is not the preferred way of using RST, but cannot be avoided in certain
cases. If possible, use semantically-defined data types.
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"]
"4" [label=< | Dictionary |
|
| KeyValuePair | entries |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | KeyValuePair |
|
| ASCII-STRING | key |
| Value | value |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | MethodCall |
|
| OCTET-VECTOR | name |
| Value | arguments |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | Value |
|
| Type | type |
| INT64 | int |
| FLOAT64 | double |
| ASCII-STRING | string |
| BOOL | bool |
| OCTET-VECTOR | binary |
| Value | array |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Type |
|
| VOID | 1 |
| INT | 2 |
| DOUBLE | 3 |
| STRING | 4 |
| BOOL | 5 |
| BINARY | 6 |
| ARRAY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"4":entries -> "5" [];
"5":value -> "2" [];
"1":arguments -> "2" [];
"2" -> "3" [dir=both,arrowtail=odiamond];
"2":array -> "2" [];
"2":type -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`MethodCall `
* :ref:`Dictionary `
* :ref:`KeyValuePair `
* :ref:`Value `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-generic-methodcall:
Message MethodCall
------------------
.. container:: message-rst-generic-methodcall-multi
.. container:: message-rst-generic-methodcall-documentation
.. py:class:: rst.generic.MethodCall
Represents a call to a named method with multiple as arguments.
.. codeauthor:: Johannes Wienke
.. py:attribute:: name
:type: :py:class:`OCTET-VECTOR`
Name of the method to call.
ASCII string.
.. py:attribute:: arguments
:type: array of :py:class:`rst.generic.Value`
The method arguments.
.. container:: message-rst-generic-methodcall-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/generic/MethodCall.proto
:lines: 12-26
:language: protobuf
:emphasize-lines: 8-8,13-13
.. _message-rst-generic-dictionary:
Message Dictionary
------------------
.. container:: message-rst-generic-dictionary-multi
.. container:: message-rst-generic-dictionary-documentation
.. py:class:: rst.generic.Dictionary
A list of key-value pairs.
.. codeauthor:: Arne Nordmann
.. py:attribute:: entries
:type: array of :py:class:`rst.generic.KeyValuePair`
The list of key-value pairs.
Ordering is ignored and duplicated keys must be avoided.
.. container:: message-rst-generic-dictionary-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/generic/Dictionary.proto
:lines: 12-21
:language: protobuf
:emphasize-lines: 8-8
.. _message-rst-generic-keyvaluepair:
Message KeyValuePair
--------------------
.. container:: message-rst-generic-keyvaluepair-multi
.. container:: message-rst-generic-keyvaluepair-documentation
.. py:class:: rst.generic.KeyValuePair
Combines a generic value with an identifying string key.
.. codeauthor:: Arne Nordmann
.. py:attribute:: key
:type: :py:class:`ASCII-STRING`
The key of this entry.
.. py:attribute:: value
:type: :py:class:`rst.generic.Value`
The value.
.. container:: message-rst-generic-keyvaluepair-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/generic/KeyValuePair.proto
:lines: 12-24
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-generic-value:
Message Value
-------------
.. container:: message-rst-generic-value-multi
.. container:: message-rst-generic-value-documentation
.. py:class:: rst.generic.Value
A representation of a generic value with a dynamic type.
Each value has a declared type in :py:attr:`type ` indicating which of the
remaining type-specific fields contains the value, expect for
:py:attr:`VOID `, where no value is transported at all (most useful for return
types).
.. codeauthor:: Johannes Wienke
.. py:attribute:: type
:type: :py:class:`rst.generic.Value.Type`
The type of the value transported in this message.
.. py:attribute:: int
:type: :py:class:`INT64`
*Not documented*
.. py:attribute:: double
:type: :py:class:`FLOAT64`
*Not documented*
.. py:attribute:: string
:type: :py:class:`ASCII-STRING`
*Not documented*
.. py:attribute:: bool
:type: :py:class:`BOOL`
*Not documented*
.. py:attribute:: binary
:type: :py:class:`OCTET-VECTOR`
*Not documented*
.. py:attribute:: array
:type: array of :py:class:`rst.generic.Value`
Contained elements can be of different types and ordering is important.
.. container:: message-rst-generic-value-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/generic/Value.proto
:language: protobuf
:emphasize-lines: 37-37,39-39,40-40,41-41,42-42,43-43,47-47
.. _message-rst-generic-value-type:
Message Type
------------
.. container:: message-rst-generic-value-type-multi
.. container:: message-rst-generic-value-type-documentation
.. py:class:: rst.generic.Value.Type
The list of supported types.
.. py:attribute:: VOID
= 1
*Not documented*
.. py:attribute:: INT
= 2
*Not documented*
.. py:attribute:: DOUBLE
= 3
*Not documented*
.. py:attribute:: STRING
= 4
*Not documented*
.. py:attribute:: BOOL
= 5
*Not documented*
.. py:attribute:: BINARY
= 6
*Not documented*
.. py:attribute:: ARRAY
= 7
Indicate that a list of Values is contained in
representing an array.
.. container:: message-rst-generic-value-type-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/generic/Value.proto
:lines: 20-32
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4,5-5,6-6,7-7,12-12