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

Class SimQueueEvent.StartArmed<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>

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

org.javades.jqueues.r5.entity.jq.queue.SimQueueEvent.StartArmed<J,Q>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

org.javades.jsimulation.r5.SimEvent

Enclosing class:

SimQueueEvent<J extends SimJob,Q extends SimQueue>

public static final class SimQueueEvent.StartArmed<J extends SimJob,Q extends SimQueue>
extends SimQueueEvent<J,Q>

A SimEvent for the start or end of the startArmed condition at a queue.

Do not ever schedule this yourself unless for your own implementation; it is for private use by SimQueue implementations.

Nested Class Summary

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.jq.queue.SimQueueEvent

SimQueueEvent.Operation<J extends SimJob,Q extends SimQueue>, SimQueueEvent.QueueAccessVacation<J extends SimJob,Q extends SimQueue>, SimQueueEvent.ServerAccessCredits<J extends SimJob,Q extends SimQueue>, SimQueueEvent.StartArmed<J extends SimJob,Q extends SimQueue>

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

SimJQEvent.Arrival<J extends SimJob,Q extends SimQueue>, SimJQEvent.AutoRevocation<J extends SimJob,Q extends SimQueue>, SimJQEvent.Departure<J extends SimJob,Q extends SimQueue>, SimJQEvent.Drop<J extends SimJob,Q extends SimQueue>, SimJQEvent.Revocation<J extends SimJob,Q extends SimQueue>, SimJQEvent.Start<J extends SimJob,Q extends SimQueue>

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

SimEntityEvent.Reset, SimEntityEvent.Update

Constructor Summary

Constructors

Constructor and Description
StartArmed(Q queue, double time, boolean startArmed) Creates a SimEvent for the start or end of the startArmed condition at a queue without SimEventAction.
StartArmed(Q queue, double time, boolean startArmed, org.javades.jsimulation.r5.SimEventAction<Q> action) Creates a SimEvent for the start or end of the startArmed condition at a queue with user-supplied SimEventAction.

Method Summary

Modifier and Type	Method and Description
SimQueueEvent.StartArmed<J,Q>	copyForQueueAndJob(Q newQueue, J newJob) Creates a new start-armed event at given queue (if non-null).
boolean	isStartArmed() Returns whether the queue is startArmed or not.

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

getJob, getQueue

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

StartArmed

public StartArmed(Q queue,
                  double time,
                  boolean startArmed,
                  org.javades.jsimulation.r5.SimEventAction<Q> action)

Creates a SimEvent for the start or end of the startArmed condition at a queue with user-supplied SimEventAction.

Do not ever schedule this yourself; it is for private use by SimQueue implementations.

Parameters:

queue - The queue to which the event applies.

time - The time of the event.

startArmed - The value of the startArmed condition at the queue.

action - The SimEventAction to take; non-null.

Throws:

IllegalArgumentException - If the queue or action is null.

See Also:

SimQueue.isStartArmed()

StartArmed

public StartArmed(Q queue,
                  double time,
                  boolean startArmed)

Creates a SimEvent for the start or end of the startArmed condition at a queue without SimEventAction.

Do not ever schedule this yourself; it is for private use by SimQueue implementations.

Parameters:

queue - The queue to which the event applies.

time - The time of the event.

startArmed - The value of the startArmed condition at the queue.

Throws:

IllegalArgumentException - If the queue is null.

See Also:

SimQueue.isStartArmed()

Method Detail

copyForQueueAndJob

public SimQueueEvent.StartArmed<J,Q> copyForQueueAndJob(Q newQueue,
                                                        J newJob)

Creates a new start-armed event at given queue (if non-null).

Specified by:

copyForQueueAndJob in class SimJQEvent<J extends SimJob,Q extends SimQueue>

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 new start-armed event at given queue (if non-null).

Throws:

IllegalArgumentException - If the job is non-null.

UnsupportedOperationException - If the SimEventAction is non-null and by whatever means a new queue has been specified.

See Also:

isStartArmed(), DefaultSimEvent.getEventAction()

isStartArmed

public final boolean isStartArmed()

Returns whether the queue is startArmed or not.

Returns:

Whether the queue is startArmed (true) or not (false).