ikr.simlib.events.calendar.simple

Class SimpleCalendar

java.lang.Object

ikr.simlib.events.calendar.Calendar

ikr.simlib.events.calendar.simple.SimpleCalendar

public class SimpleCalendar
extends Calendar

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllEvents() cancels all events
boolean	cancelAllEvents(Event theEvent) cancels all instances of one event
boolean	cancelEvent(Event theEvent) removes one specific event
boolean	cancelEvent(Event theEvent, double eventTime) removes one specific event at one specific time
int	countEventsInCalendar(Event theEvent) Counts how often the given event is scheduled.
double	getSystemTime() Returns the current simulation 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 the first event of the earliest event list
void	postEvent(Event theEvent, double eventTime, int eventPriority)
void	processNextEvent() processes the next event

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

SimpleCalendar

public SimpleCalendar()

Method Detail

postEvent

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

Specified by:

postEvent in class Calendar

popNextEvent

public Event popNextEvent()

returns the first event of the earliest event list

Specified by:

popNextEvent in class Calendar

Returns:

the removed event

cancelAllEvents

public void cancelAllEvents()

cancels all events

Specified by:

cancelAllEvents in class Calendar

cancelAllEvents

public boolean cancelAllEvents(Event theEvent)

cancels all instances of one 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)

removes one specific event at one specific time

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)

removes one specific event

Specified by:

cancelEvent in class Calendar

Returns:

true on success, false if event was not found in 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

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

getSystemTime

public double getSystemTime()

Description copied from class: Calendar

Returns the current simulation time

Specified by:

getSystemTime in class Calendar

Returns:

the simulation time

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.