ikr.simlib.events

Class Event

java.lang.Object

ikr.simlib.events.Event

Direct Known Subclasses:

InfiniteServer.InfiniteServerEvent

public abstract class Event
extends java.lang.Object

The event class is used to communicate between the application and the event queue. Every event has a specific event type, which is used to find an appropriate event handler for the event. Events may be posted to event handlers.

When an event is executed, its processEvent() method is called. This in turn calls the handleProcessEvent() method. If an event has been canceled, its cancelEvent() method is called, which calls handleCancelEvent(). To do useful work with events, handleProcessEvent(),and/or handleCancelEvent() must be implemented in a handler class.

It is important to note that an object of type Event usually represents a certain event type, which specifies the actions to be taken upon the processing of a particular event of this type. The actual event, which is associated with a particular time instant, is created when the Event is posted to the Calendar. It is safe to post an event several times.

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelEvent(double eventTime) Called only by the calendar after the event has been removed from the calendar data structure.
protected abstract void	handleCancelEvent(double eventTime)
protected abstract void	handleProcessEvent(double eventTime)
boolean	isPending()
void	posted() Called by the calendar from the Calendar.postEvent(Event, double, int) method, just before or after the event has been added to the calendars internal data structures.
void	processEvent(double eventTime) Called only by the calendar after the event has been removed from the calendar data structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

handleProcessEvent

protected abstract void handleProcessEvent(double eventTime)

handleCancelEvent

protected abstract void handleCancelEvent(double eventTime)

processEvent

public void processEvent(double eventTime)

Called only by the calendar after the event has been removed from the calendar data structure.

Parameters:

eventTime - the current system time

cancelEvent

public void cancelEvent(double eventTime)

Called only by the calendar after the event has been removed from the calendar data structure.

Parameters:

eventTime - the current system time

posted

public void posted()

Called by the calendar from the Calendar.postEvent(Event, double, int) method, just before or after the event has been added to the calendars internal data structures.

isPending

public boolean isPending()

Returns:

true if the event is currently scheduled one or multiple times, false otherwise