edu.sc.seis.sod.source.event
Interface EventSource

All Superinterfaces:
SodElement
All Known Implementing Classes:
BackwardsEventFinder, CSVEventSource, DelayedEventSource, EventFinder, NowFakeEventSource, PeriodicFakeEventSource, SimpleEventSource

public interface EventSource
extends SodElement


Method Summary
 java.lang.String getDescription()
           
 MicroSecondTimeRange getEventTimeRange()
           
 TimeInterval 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()
           
 CacheEvent[] next()
           
 

Method Detail

hasNext

boolean hasNext()
Returns:
- false when this event source will return no new events from calls to next

next

CacheEvent[] next()
Returns:
- the next set of events. Events can be returned from this method multiple times

getWaitBeforeNext

TimeInterval 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

MicroSecondTimeRange 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.

getDescription

java.lang.String getDescription()