ikr.simlib.events.calendar.standard

Class StdCalendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

ikr.simlib.events.calendar.standard.StdCalendar

public class StdCalendar
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

Modifier and Type	Field and Description
protected double	systemTime the current simulation time

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

CALENDAR

Constructor Summary

Constructors

Constructor and Description
StdCalendar()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllEvents() Cancel all events which are currently posted.
boolean	cancelAllEvents(Event theEvent) Cancel all posted occurrences of the given event.
boolean	cancelEvent(Event theEvent) Cancel the given event.
boolean	cancelEvent(Event theEvent, double eventTime) Cancel the given event, which is to be processed at time eventTime.
int	countEventsInCalendar(Event theEvent) Counts how often the given event is scheduled.
int	getSize() Get the current number of events in the calendar.
double	getSystemTime() Get the current system time.
boolean	isEventAvailable() Return true if there are events in the calendar.
Event	peekNextEvent() Returns the next event in the calendar without removing it.
double	peekNextEventTime() Returns the time stamp of the next event in the calendar without removing it.
Event	popNextEvent() Returns and removes the next event in the calendar.
void	postEvent(Event theEvent, double eventTime, int eventPriority)
void	processNextEvent() Gets the next event on the schedule and calls its event handler method.

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

getInstance, hasInstance, postEvent, setInstance

Methods inherited from class java.lang.Object

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

Field Detail

systemTime

protected double systemTime

the current simulation time

Constructor Detail

StdCalendar

public StdCalendar()

Method Detail

cancelAllEvents

public void cancelAllEvents()

Description copied from class: Calendar

Cancel all events which are currently posted.

Specified by:

cancelAllEvents in class Calendar

cancelAllEvents

public boolean cancelAllEvents(Event theEvent)

Description copied from class: Calendar

Cancel all posted occurrences of the given event.

Specified by:

cancelAllEvents in class Calendar

Returns:

true on success, false if event was not found in calendar.

cancelEvent

public boolean cancelEvent(Event theEvent,
                  double eventTime)

Description copied from class: Calendar

Cancel the given event, which is to be processed at time eventTime.

Specified by:

cancelEvent in class Calendar

Returns:

true on success, false if event was not posted for time eventTime.

cancelEvent

public boolean cancelEvent(Event theEvent)

Description copied from class: Calendar

Cancel the given event. If the event has been posted several times, it is not specified, which one is canceled.

Specified by:

cancelEvent in class Calendar

Returns:

true on success, false if event was not found in calendar.

popNextEvent

public Event popNextEvent()

Description copied from class: Calendar

Returns and removes the next event in the calendar.

Specified by:

popNextEvent in class Calendar

Returns:

the removed event

postEvent

public void postEvent(Event theEvent,
             double eventTime,
             int eventPriority)

Specified by:

postEvent in class Calendar

processNextEvent

public void processNextEvent()

Description copied from class: Calendar

Gets the next event on the schedule and calls its event handler 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

getSystemTime

public double getSystemTime()

Get the current system time.

Specified by:

getSystemTime in class Calendar

Returns:

the current system time

isEventAvailable

public boolean isEventAvailable()

Description copied from class: Calendar

Return true if there are events in the calendar.

Specified by:

isEventAvailable in class Calendar

peekNextEvent

public Event peekNextEvent()

Description copied from class: Calendar

Returns the next event in the calendar without removing it.

Specified by:

peekNextEvent in class Calendar

Returns:

preview onto the next event in the calendar

peekNextEventTime

public double 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

countEventsInCalendar

public int countEventsInCalendar(Event theEvent)

Description copied from class: Calendar

Counts how often the given event is scheduled.

Specified by:

countEventsInCalendar in class Calendar

Parameters:

theEvent - the event to count

Returns:

the number of times this event occurs in the calendars data structure.