Package rst.cbse

Component based software engineering data types.

Currently only draft types with known problems. Use with caution!

Messages

• ComponentInfo
• OutputPort
• InputPort
• ComponentState

clearer: should be made invisible via css

Message ComponentInfo

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, ...)

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

id

Type :ASCII-STRING

Not documented

lifecycle

Type :rst.cbse.ComponentState

Not documented

inputs

Type :rst.cbse.InputPort

Not documented

outputs

Type :rst.cbse.OutputPort

Not documented

uptime

Type :rst.timing.Duration

Not documented

freqency

Type :rst.timing.Frequency

Not documented

Download this file

message ComponentInfo {

    required string id = 1;

    required ComponentState lifecycle = 2;

    required InputPort inputs = 3;

    required OutputPort outputs = 4;

    optional timing.Duration uptime = 5;

    optional timing.Frequency freqency = 6;

}

Message OutputPort

class rst.cbse.OutputPort

Holds information about an output port.

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

scope

Type :ASCII-STRING

Not documented

buffersize

Type :UINT64

@unit(number-or-bytes?)

filling

Type :UINT64

@unit(number-or-bytes?)

Download this file

message OutputPort {

    required string scope = 1;

    // @unit(number-or-bytes?)
    optional uint64 buffersize = 2;

    // @unit(number-or-bytes?)
    optional uint64 filling = 3;

}

Message InputPort

class rst.cbse.InputPort

Holds information about an input port.

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

scope

Type :ASCII-STRING

Not documented

buffersize

Type :UINT64

@unit(number-or-bytes?)

filling

Type :UINT64

@unit(number-or-bytes?)

Download this file

message InputPort {

    required string scope = 1;

    // @unit(number-or-bytes?)
    optional uint64 buffersize = 2;

    // @unit(number-or-bytes?)
    optional uint64 filling = 3;

}

Message ComponentState

class rst.cbse.ComponentState

Holds information about a component`s lifecycle state.

Feel free to extend the State enum.

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

state

Type :rst.cbse.ComponentState.State

Not documented

Download this file

message ComponentState {

    /**
     * Possible lifecycle states
     */
    enum State {
        OFF = 1;
        ON = 2;
        PAUSED = 3;
        EXECUTION = 4;
        ONLINELEARNING = 5;
        OFFLINELEARNING = 6;
        RESET = 7;
    }

    required State state = 1;

}

Message State

class rst.cbse.ComponentState.State

Possible lifecycle states

OFF

= 1

Not documented

ON

= 2

Not documented

PAUSED

= 3

Not documented

EXECUTION

= 4

Not documented

ONLINELEARNING

= 5

Not documented

OFFLINELEARNING

= 6

Not documented

RESET

= 7

Not documented

Download this file

    enum State {
        OFF = 1;
        ON = 2;
        PAUSED = 3;
        EXECUTION = 4;
        ONLINELEARNING = 5;
        OFFLINELEARNING = 6;
        RESET = 7;
    }