ikr.simlib.events.calendar

Class StdOrderedCalendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

ikr.simlib.events.calendar.StdOrderedCalendar

public class StdOrderedCalendar
extends Calendar

The simplest and slowest implementation of a calendar. It consists solely of a sorted linked list of event entries, the current system time and the current calendar size.

Field Summary

Fields inherited from class ikr.simlib.events.calendar.Calendar

CALENDAR, concurrentEvents, eventsWithSameTimeStat, systemTime

Constructor Summary

Constructors

Constructor and Description
StdOrderedCalendar()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllEvents() Cancel all events which are currently posted.
int	getSize() Get the current number of events in the calendar.
boolean	isEventAvailable() Return true if there are events in the calendar.
PointInTime	peekNextEventTime() Returns the time stamp of the next event in the calendar without removing it.
ikr.simlib.events.calendar.StdOrderedCalendar.Entry	popNextEvent()
EventToken	postEvent(CalendarCallback onExecute, CalendarCallback onCancel, PointInTime eventTime, int eventPriority) Creates a new entry in the calendar.
void	processNextEvent() Gets the next event on the schedule and calls its onExecute method.

Methods inherited from class ikr.simlib.events.calendar.Calendar

getInstance, getSystemTime, hasInstance, postEvent, setInstance, setSameTimeEventStatistic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StdOrderedCalendar

public StdOrderedCalendar()

Method Detail

cancelAllEvents

public void cancelAllEvents()

Description copied from class: Calendar

Cancel all events which are currently posted.

Specified by:

cancelAllEvents in class Calendar

popNextEvent

public ikr.simlib.events.calendar.StdOrderedCalendar.Entry popNextEvent()

postEvent

public EventToken postEvent(CalendarCallback onExecute,
                   CalendarCallback onCancel,
                   PointInTime eventTime,
                   int eventPriority)

Description copied from class: Calendar

Creates a new entry in the calendar.

Specified by:

postEvent in class Calendar

Parameters:

onExecute - Function to call when the event is processed. May be null.

onCancel - Function to call when the event is cancelled. May be null.

eventTime - Time at which to call the onExecute function. Must be later or equal than the current system time returned by Calendar.getSystemTime().

eventPriority - Key used for sorting to break ties for two entries with the same eventTime.

Returns:

An object which allows event-specific interaction with the calendar.

processNextEvent

public void processNextEvent()

Description copied from class: Calendar

Gets the next event on the schedule and calls its onExecute method.

Specified by:

processNextEvent in class Calendar

getSize

public int getSize()

Get the current number of events in the calendar.

Returns:

number of events in the calendar

isEventAvailable

public boolean isEventAvailable()

Description copied from class: Calendar

Return true if there are events in the calendar.

Specified by:

isEventAvailable in class Calendar

peekNextEventTime

public PointInTime peekNextEventTime()

Description copied from class: Calendar

Returns the time stamp of the next event in the calendar without removing it.

Specified by:

peekNextEventTime in class Calendar

Returns:

preview onto the time stamp of the next event in the calendar