.. _package-rst-graph:
===================
Package rst.graph
===================
*Not documented*
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=<
| EdgeListGraphCollection |
|
EdgeListGraph | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | EdgeListGraph |
|
Node | nodes |
Edge | edges |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | Edge |
|
UINT32 | head |
UINT32 | tail |
Value | data |
Dictionary | properties |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Node |
|
Value | data |
Dictionary | properties |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Dictionary |
|
KeyValuePair | entries |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | KeyValuePair |
|
ASCII-STRING | key |
Value | value |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | Value |
|
Type | type |
INT64 | int |
FLOAT64 | double |
ASCII-STRING | string |
BOOL | bool |
OCTET-VECTOR | binary |
Value | array |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | Type |
|
VOID | 1 |
INT | 2 |
DOUBLE | 3 |
STRING | 4 |
BOOL | 5 |
BINARY | 6 |
ARRAY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"1":element -> "2"[];
"2":edges -> "8"[];
"2":nodes -> "3"[];
"8":properties -> "6"[];
"8":data -> "4"[];
"3":properties -> "6"[];
"3":data -> "4"[];
"6":entries -> "7"[];
"7":value -> "4"[];
"4" -> "5"[dir=both,arrowtail=odiamond];
"4":array -> "4"[];
"4":type -> "5"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`EdgeListGraphCollection `
* :ref:`EdgeListGraph `
* :ref:`Edge `
* :ref:`Node `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-graph-edgelistgraphcollection:
Message EdgeListGraphCollection
-------------------------------
.. container:: message-rst-graph-edgelistgraphcollection-multi
.. container:: message-rst-graph-edgelistgraphcollection-documentation
.. py:class:: rst.graph.EdgeListGraphCollection
Collection of :py:class:`EdgeListGraph ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.graph.EdgeListGraph`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-graph-edgelistgraphcollection-source
:download:`Download this file /home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/EdgeListGraphCollection.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/EdgeListGraphCollection.proto
:lines: 14-24
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-graph-edgelistgraph:
Message EdgeListGraph
---------------------
.. container:: message-rst-graph-edgelistgraph-multi
.. container:: message-rst-graph-edgelistgraph-documentation
.. py:class:: rst.graph.EdgeListGraph
Holds information about an edge list graph data structure.
.. codeauthor:: Daniel Seidel
@create_collection
.. py:attribute:: nodes
:type: array of :py:class:`rst.graph.Node`
List of the nodes in the graph.
.. py:attribute:: edges
:type: array of :py:class:`rst.graph.Edge`
List of the edges in the graph.
.. container:: message-rst-graph-edgelistgraph-source
:download:`Download this file /home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/EdgeListGraph.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/EdgeListGraph.proto
:lines: 16-28
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-graph-edge:
Message Edge
------------
.. container:: message-rst-graph-edge-multi
.. container:: message-rst-graph-edge-documentation
.. py:class:: rst.graph.Edge
Incident nodes and associated data of an edge in an edge-list
graph.
.. codeauthor:: Daniel Seidel
.. py:attribute:: head
:type: :py:class:`UINT32`
Index of the head node in the graph's node list.
.. py:attribute:: tail
:type: :py:class:`UINT32`
Index of the tail node in the graph's node list.
.. py:attribute:: data
:type: array of :py:class:`rst.generic.Value`
Arbitrary data describing the edge, e.g. traversal cost.
Specific to application creating the graph.
.. py:attribute:: properties
:type: :py:class:`rst.generic.Dictionary`
Data describing the relationship or properties of it in a
key:value manner.
.. container:: message-rst-graph-edge-source
:download:`Download this file /home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/Edge.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/Edge.proto
:lines: 16-41
:language: protobuf
:emphasize-lines: 6-6,11-11,18-18,24-24
.. _message-rst-graph-node:
Message Node
------------
.. container:: message-rst-graph-node-multi
.. container:: message-rst-graph-node-documentation
.. py:class:: rst.graph.Node
Node with associated data in an edge-list graph.
.. codeauthor:: Daniel Seidel
.. py:attribute:: data
:type: array of :py:class:`rst.generic.Value`
Arbitrary data describing the node, e.g. location coordinates.
Specific to application creating the graph.
.. py:attribute:: properties
:type: :py:class:`rst.generic.Dictionary`
Data describing the node or properties of it in a key:value
manner.
.. container:: message-rst-graph-node-source
:download:`Download this file /home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/Node.proto>`
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/graph/Node.proto
:lines: 15-30
:language: protobuf
:emphasize-lines: 8-8,14-14