ikr.simlib.events.calendar

Class OrderedTreeSetCalendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

ikr.simlib.events.calendar.OrderedTreeSetCalendar

public class OrderedTreeSetCalendar
extends Calendar

Calendar which relies on a TreeSet to keep the events in order.

Each time an event is posted, an associated Entry object is created. Entry objects are comarable by time, priority and ID. The ID is an artificial attribute which discriminates two entries with the same time and priority. This

• prohibits that these entries overwrite each other in the set
• ensures that events with same time and priority are processed in insertion order

The data structure used in this class requires only two objects to be created for each event that is placed in the calendar (TreeSetCalendar.Entry and TreeMap.Entry). SimpleOrderedCalendar, for comparison, requires two additional objects (LinkedList and LinkedList.Entry).

The complexity of the postEvent(CalendarCallback, CalendarCallback, PointInTime, int) and EventToken.cancel() methods is log(n), where n is the number of events in the calendar.

Field Summary

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

CALENDAR, concurrentEvents, eventsWithSameTimeStat, systemTime

Constructor Summary

Constructors

Constructor and Description
OrderedTreeSetCalendar()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllEvents() Cancel all events which are currently posted.
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.
EventToken	postEvent(CalendarCallback process, CalendarCallback cancel, 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

OrderedTreeSetCalendar

public OrderedTreeSetCalendar()

Method Detail

postEvent

public EventToken postEvent(CalendarCallback process,
                   CalendarCallback cancel,
                   PointInTime eventTime,
                   int eventPriority)

Description copied from class: Calendar

Creates a new entry in the calendar.

Specified by:

postEvent in class Calendar

Parameters:

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

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

cancelAllEvents

public void cancelAllEvents()

Description copied from class: Calendar

Cancel all events which are currently posted.

Specified by:

cancelAllEvents in class 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

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