com.agi.moxie.api.signals

Interface EventSignal

All Known Implementing Classes:

BooleanEdgeSignal, ScriptedEventSignal

public interface EventSignal

A signal that produces discrete event times.

Ultimately, the event-driven simulation is searching for event times. Though specific event types correspond to specific signal types (for example, change events are detected by observing BooleanSignals), in the end all event sources are resolved to EventSignals.

The only relevant information in this signal is the moments in time when the events occur.

Method Summary

Modifier and Type	Method and Description
Stream<MoxieTime>	getEventsWithin(Interval<MoxieTime> interval) Reports the events that occur within the interval.

Method Detail

getEventsWithin

@NotNull
Stream<MoxieTime> getEventsWithin(@NotNull
                                            Interval<MoxieTime> interval)

Reports the events that occur within the interval. The timestamps of the events must be distinct and must be strictly increasing.

Parameters:

interval - The interval over which events should be reported.

Returns:

A stream of the events within the interval, in order.