ikr.simlib.events.calendar

Class Calendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

Direct Known Subclasses:

SimpleCalendar, StdCalendar

public abstract class Calendar
extends java.lang.Object

Calendars are special event handlers derived from the abstract base class Calendar. The classes store references to event objects along with a time stamp when postEvent() is called. Additionally, a priority of the event can be provided. These priorities come into effect if events are posted at the same time. If events are posted at the same time, they are processed in the order of decreasing priority, i.e., the event with the highest priority is processed first. With the method popNextEvent() The event references can be retrieved later in the order given by the time stamps. Calendars are used by models, see Model for more details.

Event priorities are integer numbers and may be negative. The default priority is 0. The processing order of events with the same time and the same priority is not defined and may vary in-between calendar implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Calendar	CALENDAR reference to calendar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Calendar()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

CALENDAR

protected static Calendar CALENDAR

reference to calendar

Constructor Detail

Calendar

protected Calendar()

Method Detail

getInstance

public static Calendar getInstance()

calendar access method

setInstance

public static void setInstance(Calendar calendar)

hasInstance

public static boolean hasInstance()

postEvent

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

postEvent

public void postEvent(Event theEvent,
             double eventTime)

cancelEvent

public abstract boolean cancelEvent(Event theEvent,
                  double eventTime)

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

Returns:

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

cancelEvent

public abstract boolean cancelEvent(Event theEvent)

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

Returns:

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

cancelAllEvents

public abstract void cancelAllEvents()

Cancel all events which are currently posted.

cancelAllEvents

public abstract boolean cancelAllEvents(Event theEvent)

Cancel all posted occurrences of the given event.

Returns:

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

popNextEvent

public abstract Event popNextEvent()

Returns and removes the next event in the calendar.

Returns:

the removed event

isEventAvailable

public abstract boolean isEventAvailable()

Return true if there are events in the calendar.

peekNextEvent

public abstract Event peekNextEvent()

Returns the next event in the calendar without removing it.

Returns:

preview onto the next event in the calendar

peekNextEventTime

public abstract double peekNextEventTime()

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

Returns:

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

getSystemTime

public abstract double getSystemTime()

Returns the current simulation time

Returns:

the simulation time

processNextEvent

public abstract void processNextEvent()

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

countEventsInCalendar

public abstract int countEventsInCalendar(Event theEvent)

Counts how often the given event is scheduled.

Parameters:

theEvent - the event to count

Returns:

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