org.javades.jqueues.r5.entity.jq.queue

Class SimQueueEventScheduler

java.lang.Object

org.javades.jqueues.r5.entity.SimEntityEventScheduler

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

org.javades.jqueues.r5.entity.jq.queue.SimQueueEventScheduler

public abstract class SimQueueEventScheduler
extends SimJQEventScheduler

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

Method Summary

Modifier and Type	Method and Description
static <J extends SimJob,Q extends SimQueue> void	scheduleQueueAccessVacation(Q queue, double time, boolean vacation) Creates a (default) queue-access vacation event and schedules it.
static <J extends SimJob,Q extends SimQueue> void	scheduleServerAccessCredits(Q queue, double time, int credits) Creates a (default) a server-access-credits event and schedules it.

Methods inherited from class org.javades.jqueues.r5.entity.jq.SimJQEventScheduler

scheduleJobArrival, scheduleJobRevocation, scheduleJQ, scheduleJQ

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

SimQueueEventScheduler

protected SimQueueEventScheduler()

Inhibits instantiation (somewhat) yet allows extensions.

Throws:

UnsupportedOperationException - Always.

Method Detail

scheduleQueueAccessVacation

public static <J extends SimJob,Q extends SimQueue> void scheduleQueueAccessVacation(Q queue,
                                                                                     double time,
                                                                                     boolean vacation)

Creates a (default) queue-access vacation event and schedules it.

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

Parameters:

queue - The queue at which to start or end a queue-access vacation.

time - The time at which to start or end a queue-access vacation.

vacation - Whether a queue-access vacation starts (true) or ends (false).

Throws:

IllegalArgumentException - If the 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.

See Also:

SimQueueEvent.QueueAccessVacation, SimQueue.setQueueAccessVacation(double, boolean), SimJQEventScheduler.scheduleJQ(SimEventList, SimJQEvent)

scheduleServerAccessCredits

public static <J extends SimJob,Q extends SimQueue> void scheduleServerAccessCredits(Q queue,
                                                                                     double time,
                                                                                     int credits)

Creates a (default) a server-access-credits event and schedules it.

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

Parameters:

queue - The queue at which to set server-access credits.

time - The time at which to set server-access credits.

credits - The number of credits to grant.

Throws:

IllegalArgumentException - If the 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 the number of credits is strictly negative.

See Also:

SimQueueEvent.ServerAccessCredits, SimQueue.setServerAccessCredits(double, int), SimJQEventScheduler.scheduleJQ(SimEventList, SimJQEvent)