.. _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
EdgeListGraphelement
>,shape=box,style=filled,fillcolor="white"]; "2" [label=<
EdgeListGraph
Nodenodes
Edgeedges
>,shape=box,style=filled,fillcolor="white"]; "8" [label=<
Edge
UINT32head
UINT32tail
Valuedata
>,shape=box,style=filled,fillcolor="white"]; "3" [label=<
Node
Valuedata
>,shape=box,style=filled,fillcolor="white"]; "4" [label=<
Value
Typetype
INT64int
FLOAT64double
ASCII-STRINGstring
BOOLbool
OCTET-VECTORbinary
Valuearray
>,shape=box,style=filled,fillcolor="white"]; "6" [label=<
Value
Typetype
INT64int
FLOAT64double
ASCII-STRINGstring
BOOLbool
OCTET-VECTORbinary
>,shape=box,style=filled,fillcolor="white"]; "7" [label=<
Type
VOID1
INT2
DOUBLE3
STRING4
BOOL5
BINARY6
ARRAY7
>,shape=box,style=filled,fillcolor="white"]; "5" [label=<
Type
VOID1
INT2
DOUBLE3
STRING4
BOOL5
BINARY6
ARRAY7
>,shape=box,style=filled,fillcolor="white"]; "1":element -> "2" []; "2":edges -> "8" []; "2":nodes -> "3" []; "8":data -> "4" []; "3":data -> "4" []; "4" -> "5" []; "4":array -> "6" []; "4":type -> "5" []; "6" -> "7" []; "6":type -> "7" []; .. container:: mess4ge-list .. container:: messages * :ref:`EdgeListGraphCollection ` * :ref:`EdgeListGraph ` * :ref:`Node ` * :ref:`Edge ` .. 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 ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/graph/EdgeListGraphCollection.proto :lines: 12-22 :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 ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/graph/EdgeListGraph.proto :lines: 16-28 :language: protobuf :emphasize-lines: 6-6,11-11 .. _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. .. container:: message-rst-graph-node-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/graph/Node.proto :lines: 14-23 :language: protobuf :emphasize-lines: 8-8 .. _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. .. container:: message-rst-graph-edge-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/graph/Edge.proto :lines: 15-34 :language: protobuf :emphasize-lines: 6-6,11-11,18-18