Package edu.sc.seis.sod.source.event
Interface EventSource
- All Superinterfaces:
Source
- All Known Implementing Classes:
AbstractEventSource
,BackwardsEventSource
,CSVEventSource
,DelayedEventSource
,FdsnEvent
,NowFakeEventSource
,PeriodicFakeEventSource
,SimpleEventSource
public interface EventSource extends Source
-
Method Summary
Modifier and Type Method Description edu.sc.seis.sod.model.common.TimeRange
getEventTimeRange()
java.time.Duration
getWaitBeforeNext()
If the source needs to wait for more events to arrive, it should return the amount of time it wants to wait with this method.boolean
hasNext()
edu.sc.seis.sod.model.event.CacheEvent[]
next()
-
Method Details
-
hasNext
boolean hasNext()- Returns:
- - false when this event source will return no new events from calls to next
-
next
edu.sc.seis.sod.model.event.CacheEvent[] next()- Returns:
- - the next set of events. Events can be returned from this method multiple times
-
getWaitBeforeNext
java.time.Duration getWaitBeforeNext()If the source needs to wait for more events to arrive, it should return the amount of time it wants to wait with this method. -
getEventTimeRange
edu.sc.seis.sod.model.common.TimeRange getEventTimeRange()- Returns:
- - a MicroSecondTimeRange starting at least as early as the earliest event and ending at least as late as the latest event. No event should be returned by this source with an origin before the begin time or after the end time of this range.
-