org.javades.jqueues.r5.entity.jq

Class SimJQEvent<J extends SimJob,Q extends SimQueue>

java.lang.Object

org.javades.jsimulation.r5.DefaultSimEvent

org.javades.jqueues.r5.entity.SimEntityEvent

org.javades.jqueues.r5.entity.jq.SimJQEvent<J,Q>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

org.javades.jsimulation.r5.SimEvent

Direct Known Subclasses:

SimJobEvent, SimJQEvent.Arrival, SimJQEvent.AutoRevocation, SimJQEvent.Departure, SimJQEvent.Drop, SimJQEvent.Revocation, SimJQEvent.Start, SimQueueCatchUpEvent, SimQueueEvent, SimQueueGateEvent

public abstract class SimJQEvent<J extends SimJob,Q extends SimQueue>
extends SimEntityEvent

A SimEvent for a SimEntity operation on (both) jobs and queues.

This class only administers the key parameters for the event; it does not actually schedule it.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimJQEvent.Arrival<J extends SimJob,Q extends SimQueue> An arrival SimEvent of a job at a queue.
static class	SimJQEvent.AutoRevocation<J extends SimJob,Q extends SimQueue> An auto-revocation SimEvent of a job at a queue.
static class	SimJQEvent.Departure<J extends SimJob,Q extends SimQueue> A departure SimEvent of a job at a queue.
static class	SimJQEvent.Drop<J extends SimJob,Q extends SimQueue> A drop SimEvent of a job at a queue.
static class	SimJQEvent.Revocation<J extends SimJob,Q extends SimQueue> A revocation SimEvent (request) of a job at a queue.
static class	SimJQEvent.Start<J extends SimJob,Q extends SimQueue> A start SimEvent of a job at a queue.

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.SimEntityEvent

SimEntityEvent.Reset, SimEntityEvent.Update

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimJQEvent(String name, double time, Q queue, J job, org.javades.jsimulation.r5.SimEventAction<? extends SimEntity> action) Creates a new event for a queue.

Method Summary

Modifier and Type	Method and Description
abstract SimJQEvent<J,Q>	copyForQueueAndJob(Q newQueue, J newJob) Creates a copy of this event, but for a different queue and/or a different job.
J	getJob() Gets the job (if applicable) to which the event applies.
Q	getQueue() Gets the queue (if applicable) at which the event occurs.

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

getEntity

Methods inherited from class org.javades.jsimulation.r5.DefaultSimEvent

getEventAction, getName, getObject, getSimEventListDeconflictValue, getTime, setEventAction, setName, setObject, setSimEventListDeconflictValue, setTime, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SimJQEvent

protected SimJQEvent(String name,
                     double time,
                     Q queue,
                     J job,
                     org.javades.jsimulation.r5.SimEventAction<? extends SimEntity> action)

Creates a new event for a queue.

Parameters:

name - The (optional) name of the event, may be null.

time - The time at which the event occurs.

queue - The queue related to the event (if applicable), may be null.

job - The job related to the event (if applicable), may be null.

action - The SimEventAction to take; may be null.

Method Detail

copyForQueueAndJob

public abstract SimJQEvent<J,Q> copyForQueueAndJob(Q newQueue,
                                                   J newJob)

Creates a copy of this event, but for a different queue and/or a different job.

When a parameter is null, it is left untouched.

The event's action, if non-null, has to be copied into an action retrofitted to the new queue and/or job.

Parameters:

newQueue - The new queue (the SimQueue to which the newly created event applies).

newJob - The new job (the SimQueue to which the newly created event applies).

Returns:

A copy of this event but for given queue and/or job.

Throws:

IllegalArgumentException - If (the combination of) the new queue and/or new job is illegal for this event type.

UnsupportedOperationException - If the event cannot be copied for the new values of queue and job, for instance, because of lack of knowledge on the SimEventAction present.

getQueue

public final Q getQueue()

Gets the queue (if applicable) at which the event occurs.

Returns:

The queue (if applicable) to which the event applies, may be null.

getJob

public final J getJob()

Gets the job (if applicable) to which the event applies.

Returns:

The job (if applicable) to which the event applies, may be null.