org.javades.jqueues.r5.entity.jq

Class SimJQEventScheduler

java.lang.Object

org.javades.jqueues.r5.entity.SimEntityEventScheduler

org.javades.jqueues.r5.entity.jq.SimJQEventScheduler

Direct Known Subclasses:

SimQueueEventScheduler

public abstract class SimJQEventScheduler
extends SimEntityEventScheduler

A utility class capable of scheduling SimJQEvents 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	SimJQEventScheduler() Inhibits instantiation (somewhat) yet allows extensions.

Method Summary

Modifier and Type	Method and Description
static <J extends SimJob,Q extends SimQueue> void	scheduleJobArrival(J job, Q queue, double arrivalTime) Creates a (default) job-arrival event and schedules it.
static <J extends SimJob,Q extends SimQueue> void	scheduleJobRevocation(J job, Q queue, double revocationTime, boolean interruptService) Creates a (default) job-revocation event and schedules it.
static <J extends SimJob,Q extends SimQueue> void	scheduleJQ(org.javades.jsimulation.r5.SimEventList eventList, boolean reset, double resetTime, Set<SimJQEvent<J,Q>> queueEvents) Schedules all SimJQEvents on the given SimEventList, optionally after resetting it to a specific time.
static <J extends SimJob,Q extends SimQueue> void	scheduleJQ(org.javades.jsimulation.r5.SimEventList eventList, SimJQEvent<J,Q> queueEvent) Schedules a single job and/or queue event on a given event list.

Methods inherited from class org.javades.jqueues.r5.entity.SimEntityEventScheduler

scheduleE, scheduleE, scheduleResetEntity, scheduleUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

SimJQEventScheduler

protected SimJQEventScheduler()

Inhibits instantiation (somewhat) yet allows extensions.

Throws:

UnsupportedOperationException - Always.

Method Detail

scheduleJQ

public static <J extends SimJob,Q extends SimQueue> void scheduleJQ(org.javades.jsimulation.r5.SimEventList eventList,
                                                                    boolean reset,
                                                                    double resetTime,
                                                                    Set<SimJQEvent<J,Q>> queueEvents)

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

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

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).

queueEvents - The SimJQEvents 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:

scheduleJQ(SimEventList, SimJQEvent)

scheduleJQ

public static <J extends SimJob,Q extends SimQueue> void scheduleJQ(org.javades.jsimulation.r5.SimEventList eventList,
                                                                    SimJQEvent<J,Q> queueEvent)

Schedules a single job and/or queue event on a given event list.

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

Parameters:

eventList - The event list, non-null.

queueEvent - The queue 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), if no event list could be retrieved form the queue, or if the job is attached to a different event list than the queue.

See Also:

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

scheduleJobArrival

public static <J extends SimJob,Q extends SimQueue> void scheduleJobArrival(J job,
                                                                            Q queue,
                                                                            double arrivalTime)

Creates a (default) job-arrival event and schedules it.

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

Parameters:

job - The job that arrives.

queue - The queue at which the job arrives.

arrivalTime - The scheduled arrival time.

Throws:

IllegalArgumentException - If the job or queue is null, if the scheduled time is in the past (compared to the time on the event list), if no event list could be retrieved form the queue, or if the job is attached to a different event list than the queue.

See Also:

SimJQEvent.Arrival, SimQueue.arrive(double, J), scheduleJQ(SimEventList, SimJQEvent)

scheduleJobRevocation

public static <J extends SimJob,Q extends SimQueue> void scheduleJobRevocation(J job,
                                                                               Q queue,
                                                                               double revocationTime,
                                                                               boolean interruptService)

Creates a (default) job-revocation event and schedules it.

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

Parameters:

job - The job that is to be revoked.

queue - The queue at which the job is to be revoked from.

revocationTime - The scheduled revocation time.

interruptService - Whether to request interruption of service (if applicable).

Throws:

IllegalArgumentException - If the job or queue is null, if the scheduled time is in the past (compared to the time on the event list), if no event list could be retrieved form the queue, or if the job is attached to a different event list than the queue.

See Also:

SimJQEvent.Revocation, SimQueue.revoke(double, J, boolean), scheduleJQ(SimEventList, SimJQEvent)