Struct Monitor

pub struct Monitor<Source, Mode, Verdict = Incremental, VerdictTime = RelativeFloat>
where
    Source: EventFactory,
    Mode: ExecutionMode,
    Verdict: VerdictRepresentation,
    VerdictTime: OutputTimeRepresentation + 'static,
{ /* private fields */ }

The Monitor is the central object exposed by the API.

The Monitor accepts new events and computes streams. It can compute event-based streams based on new events through accept_event. It can also simply advance periodic streams up to a given timestamp through accept_time. The generic argument Source implements the EventFactory trait describing the input source of the API. The generic argument SourceTime implements the TimeRepresentation trait defining the input time format. The generic argument Verdict implements the VerdictRepresentation trait describing the output format of the API that is by default Incremental. The generic argument VerdictTime implements the TimeRepresentation trait defining the output time format. It defaults to RelativeFloat

Implementations

impl<Source, Mode, Verdict, VerdictTime> Monitor<Source, Mode, Verdict, VerdictTime>

where Source: EventFactory, Mode: ExecutionMode, Verdict: VerdictRepresentation, VerdictTime: OutputTimeRepresentation,

Crate-public interface

pub fn setup( config: Config<Mode, VerdictTime>, setup_data: Source::CreationData, ) -> Result<Monitor<Source, Mode, Verdict, VerdictTime>, EventFactoryError>

setup

impl<Source, Mode, Verdict, VerdictTime> Monitor<Source, Mode, Verdict, VerdictTime>

where Source: EventFactory, Mode: ExecutionMode, Verdict: VerdictRepresentation, VerdictTime: OutputTimeRepresentation,

Public interface

pub fn accept_event( &mut self, ev: Source::Record, ts: <Mode::SourceTime as TimeRepresentation>::InnerTime, ) -> Result<Verdicts<Verdict, VerdictTime>, EventFactoryError>

Computes all periodic streams up through the new timestamp and then handles the input event.

The new event is therefore not seen by periodic streams up through a new timestamp.

pub fn accept_time( &mut self, ts: <Mode::SourceTime as TimeRepresentation>::InnerTime, ) -> Vec<(VerdictTime::InnerTime, Verdict)>

Computes all periodic streams up through and including the timestamp.

pub fn ir(&self) -> &RtLolaMir

Returns the underlying representation of the specification as an RtLolaMir

pub fn name_for_input(&self, id: InputReference) -> &str

Get the name of an input stream based on its InputReference.

The reference is valid for the lifetime of the monitor.

pub fn name_for_output(&self, id: OutputReference) -> &str

Get the name of an output stream based on its OutputReference.

The reference is valid for the lifetime of the monitor.

pub fn trigger_stream_index(&self, id: usize) -> usize

Get the OutputReference of a trigger based on its index.

pub fn number_of_input_streams(&self) -> usize

Get the number of input streams.

pub fn number_of_output_streams(&self) -> usize

Get the number of output streams (this includes one output stream for each trigger).

pub fn number_of_triggers(&self) -> usize

Get the number of triggers.

pub fn type_of_input(&self, id: InputReference) -> &Type

Get the type of an input stream based on its InputReference.

The reference is valid for the lifetime of the monitor.

pub fn type_of_output(&self, id: OutputReference) -> &Type

Get the type of an output stream based on its OutputReference.

The reference is valid for the lifetime of the monitor.

pub fn extend_rate_of_output(&self, id: OutputReference) -> Option<Duration>

Get the extend rate of an output stream based on its OutputReference.

The reference is valid for the lifetime of the monitor.

pub fn with_verdict_representation<T: VerdictRepresentation>( self, ) -> Monitor<Source, Mode, T, VerdictTime>

Switch VerdictRepresentations of the Monitor.