.. _package-rst-cbse:
==================
Package rst.cbse
==================
Component based software engineering data types.
Currently only draft types with known problems. Use with caution!
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=< | ComponentInfo |
|
| ASCII-STRING | id |
| ComponentState | lifecycle |
| InputPort | inputs |
| OutputPort | outputs |
| Duration | uptime |
| Frequency | freqency |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | Frequency |
|
| FLOAT64 | hz |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Duration |
|
| UINT64 | time |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | OutputPort |
|
| ASCII-STRING | scope |
| UINT64 | buffersize |
| UINT64 | filling |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | InputPort |
|
| ASCII-STRING | scope |
| UINT64 | buffersize |
| UINT64 | filling |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | ComponentState |
|
| State | state |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | State |
|
| OFF | 1 |
| ON | 2 |
| PAUSED | 3 |
| EXECUTION | 4 |
| ONLINELEARNING | 5 |
| OFFLINELEARNING | 6 |
| RESET | 7 |
>,shape=box,style=filled,fillcolor="white"];
"1":freqency -> "7" [];
"1":uptime -> "6" [];
"1":outputs -> "5" [];
"1":inputs -> "4" [];
"1":lifecycle -> "2" [];
"2" -> "3" [dir=both,arrowtail=odiamond];
"2":state -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`ComponentInfo `
* :ref:`OutputPort `
* :ref:`InputPort `
* :ref:`ComponentState `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-cbse-componentinfo:
Message ComponentInfo
---------------------
.. container:: message-rst-cbse-componentinfo-multi
.. container:: message-rst-cbse-componentinfo-documentation
.. py:class:: rst.cbse.ComponentInfo
Holds information about a component.
.. todo::
Should be split up in static (structure) and dynamic part
(timing, state, buffer filling levels, ...)
.. codeauthor:: Arne Nordmann
.. py:attribute:: id
:type: :py:class:`ASCII-STRING`
*Not documented*
.. py:attribute:: lifecycle
:type: :py:class:`rst.cbse.ComponentState`
*Not documented*
.. py:attribute:: inputs
:type: :py:class:`rst.cbse.InputPort`
*Not documented*
.. py:attribute:: outputs
:type: :py:class:`rst.cbse.OutputPort`
*Not documented*
.. py:attribute:: uptime
:type: :py:class:`rst.timing.Duration`
*Not documented*
.. py:attribute:: freqency
:type: :py:class:`rst.timing.Frequency`
*Not documented*
.. container:: message-rst-cbse-componentinfo-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/cbse/ComponentInfo.proto
:lines: 19-33
:language: protobuf
:emphasize-lines: 3-3,5-5,7-7,9-9,11-11,13-13
.. _message-rst-cbse-outputport:
Message OutputPort
------------------
.. container:: message-rst-cbse-outputport-multi
.. container:: message-rst-cbse-outputport-documentation
.. py:class:: rst.cbse.OutputPort
Holds information about an output port.
.. codeauthor:: Arne Nordmann
.. py:attribute:: scope
:type: :py:class:`ASCII-STRING`
*Not documented*
.. py:attribute:: buffersize
:type: :py:class:`UINT64`
@unit(number-or-bytes?)
.. py:attribute:: filling
:type: :py:class:`UINT64`
@unit(number-or-bytes?)
.. container:: message-rst-cbse-outputport-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/cbse/OutputPort.proto
:lines: 10-20
:language: protobuf
:emphasize-lines: 3-3,6-6,9-9
.. _message-rst-cbse-inputport:
Message InputPort
-----------------
.. container:: message-rst-cbse-inputport-multi
.. container:: message-rst-cbse-inputport-documentation
.. py:class:: rst.cbse.InputPort
Holds information about an input port.
.. codeauthor:: Arne Nordmann
.. py:attribute:: scope
:type: :py:class:`ASCII-STRING`
*Not documented*
.. py:attribute:: buffersize
:type: :py:class:`UINT64`
@unit(number-or-bytes?)
.. py:attribute:: filling
:type: :py:class:`UINT64`
@unit(number-or-bytes?)
.. container:: message-rst-cbse-inputport-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/cbse/InputPort.proto
:lines: 10-20
:language: protobuf
:emphasize-lines: 3-3,6-6,9-9
.. _message-rst-cbse-componentstate:
Message ComponentState
----------------------
.. container:: message-rst-cbse-componentstate-multi
.. container:: message-rst-cbse-componentstate-documentation
.. py:class:: rst.cbse.ComponentState
Holds information about a component`s lifecycle state.
Feel free to extend the State enum.
.. codeauthor:: Arne Nordmann
.. py:attribute:: state
:type: :py:class:`rst.cbse.ComponentState.State`
*Not documented*
.. container:: message-rst-cbse-componentstate-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/cbse/ComponentState.proto
:lines: 12-29
:language: protobuf
:emphasize-lines: 16-16
.. _message-rst-cbse-componentstate-state:
Message State
-------------
.. container:: message-rst-cbse-componentstate-state-multi
.. container:: message-rst-cbse-componentstate-state-documentation
.. py:class:: rst.cbse.ComponentState.State
Possible lifecycle states
.. py:attribute:: OFF
= 1
*Not documented*
.. py:attribute:: ON
= 2
*Not documented*
.. py:attribute:: PAUSED
= 3
*Not documented*
.. py:attribute:: EXECUTION
= 4
*Not documented*
.. py:attribute:: ONLINELEARNING
= 5
*Not documented*
.. py:attribute:: OFFLINELEARNING
= 6
*Not documented*
.. py:attribute:: RESET
= 7
*Not documented*
.. container:: message-rst-cbse-componentstate-state-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/sandbox/rst/cbse/ComponentState.proto
:lines: 17-25
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4,5-5,6-6,7-7,8-8