ikr.simlib.events.calendar

Class SimpleOrderedCalendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

ikr.simlib.events.calendar.SimpleOrderedCalendar

Direct Known Subclasses:

SimpleRandomCalendar

public class SimpleOrderedCalendar
extends Calendar

A calendar implementation that uses java collection for the sake of simplicity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SimpleOrderedCalendar.Entry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.SortedMap<PointInTime,java.util.LinkedList<SimpleOrderedCalendar.Entry>>	timeline the time line assigns lists of events to their time instances

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

CALENDAR, concurrentEvents, eventsWithSameTimeStat, systemTime

Constructor Summary

Constructors

Constructor and Description
SimpleOrderedCalendar()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllEvents() cancels all events
PointInTime	getSystemTime() Returns the current simulation time
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() processes the next event

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

getInstance, hasInstance, postEvent, setInstance, setSameTimeEventStatistic

Methods inherited from class java.lang.Object

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

Field Detail

timeline

protected final java.util.SortedMap<PointInTime,java.util.LinkedList<SimpleOrderedCalendar.Entry>> timeline

the time line assigns lists of events to their time instances

Constructor Detail

SimpleOrderedCalendar

public SimpleOrderedCalendar()

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()

cancels all events

Specified by:

cancelAllEvents in class Calendar

processNextEvent

public void processNextEvent()

processes the next event

Specified by:

processNextEvent 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

getSystemTime

public PointInTime getSystemTime()

Description copied from class: Calendar

Returns the current simulation time

Overrides:

getSystemTime in class Calendar

Returns:

the simulation time