org.javades.jqueues.r5.entity

Class SimEntityEventScheduler

java.lang.Object

org.javades.jqueues.r5.entity.SimEntityEventScheduler

Direct Known Subclasses:

SimJQEventScheduler

public abstract class SimEntityEventScheduler
extends Object

A utility class capable of scheduling SimEntityEvents on an event list.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimEntityEventScheduler() Inhibits instantiation (somewhat) yet allows extensions.

Method Summary

Modifier and Type	Method and Description
static void	scheduleE(org.javades.jsimulation.r5.SimEventList eventList, boolean reset, double resetTime, Set<SimEntityEvent> entityEvents) Schedules all SimEntityEvents on the given SimEventList, optionally after resetting it to a specific time.
static void	scheduleE(org.javades.jsimulation.r5.SimEventList eventList, SimEntityEvent entityEvent) Schedules a single entity event on a given event list.
static void	scheduleResetEntity(org.javades.jsimulation.r5.SimEventList eventList, SimEntity entity, double resetTime) Creates a default reset (entity) event and schedules it.
static void	scheduleUpdate(org.javades.jsimulation.r5.SimEventList eventList, SimEntity entity, double updateTime) Creates a default update event and schedules it.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimEntityEventScheduler

protected SimEntityEventScheduler()

Inhibits instantiation (somewhat) yet allows extensions.

Throws:

UnsupportedOperationException - Always.

Method Detail

scheduleE

public static void scheduleE(org.javades.jsimulation.r5.SimEventList eventList,
                             boolean reset,
                             double resetTime,
                             Set<SimEntityEvent> entityEvents)

Schedules all SimEntityEvents on the given SimEventList, optionally after resetting it to a specific time.

Parameters:

eventList - The event list.

reset - Whether to reset the event list before scheduling.

resetTime - The new time to which to reset the event list (if requested so).

entityEvents - The SimEntityEvents to schedule.

Throws:

IllegalArgumentException - If eventList == null or the (non-null) set of events has at least one null entry, or if any of the events is to be scheduled in the past after the optional event-list reset (compared to the time on the event list),

See Also:

scheduleE(SimEventList, SimEntityEvent)

scheduleE

public static void scheduleE(org.javades.jsimulation.r5.SimEventList eventList,
                             SimEntityEvent entityEvent)

Schedules a single entity event on a given event list.

Parameters:

eventList - The event list, non-null.

entityEvent - The entity event, non-null.

Throws:

IllegalArgumentException - If the event list or event is null, if the scheduled time is in the past (compared to the time on the event list).

See Also:

scheduleE(SimEventList, boolean, double, java.util.Set)

scheduleResetEntity

public static void scheduleResetEntity(org.javades.jsimulation.r5.SimEventList eventList,
                                       SimEntity entity,
                                       double resetTime)

Creates a default reset (entity) event and schedules it.

The event resets the entity, not the event list!

Parameters:

eventList - The event list, non-null.

entity - The entity to reset, non-null.

resetTime - The scheduled reset (entity) time.

Throws:

IllegalArgumentException - If the event list or entity is null, if the scheduled time is in the past (compared to the time on the event list), if the entity has a non-null event list different from the argument.

See Also:

SimEntityEvent.Reset, SimEntity.resetEntity(), scheduleE(SimEventList, SimEntityEvent)

scheduleUpdate

public static void scheduleUpdate(org.javades.jsimulation.r5.SimEventList eventList,
                                  SimEntity entity,
                                  double updateTime)

Creates a default update event and schedules it.

Parameters:

eventList - The event list, non-null.

entity - The entity to update, non-null.

updateTime - The scheduled update time.

Throws:

IllegalArgumentException - If the event list or entity is null, if the scheduled time is in the past (compared to the time on the event list), if the entity has a non-null event list different from the argument.

See Also:

SimEntityEvent.Update, SimEntity.update(double), scheduleE(SimEventList, SimEntityEvent)