KSLCore/ksl.calendar/PriorityQueueEventCalendar

PriorityQueueEventCalendar

This class provides an event calendar by using a priority queue to hold the underlying events.

Constructors

constructor()

open override val isEmpty: Boolean

Checks to see if the calendar is empty

open override fun add(event: KSLEvent<*>)

The add method will place the provided JSLEvent into the underlying data structure ensuring the ordering of the events to be processed

open override fun clear()

Clears or cancels every event in the data structure. Removes all JSLEvents from the data structure.

open override fun nextEvent(): KSLEvent<*>

Returns the next JSLEvent to be executed. The event is removed from the calendar if it exists

open override fun peekNext(): KSLEvent<*>?

Peeks at the next event without removing it

open override fun size(): Int

Returns the number of events in the calendar