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

Class Tandem<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends Tandem>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

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

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

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.tandem.Tandem<DJ,DQ,J,Q>

Type Parameters:

DJ - The delegate-job type.

DQ - The queue-type for delegate jobs.

J - The job type.

Q - The queue type for jobs.

All Implemented Interfaces:

SimQueueComposite<DJ,DQ,J,Q>, SimQueueSelector<J,DQ>, SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimEntityListener, org.javades.jsimulation.r5.SimEventListResetListener

public class Tandem<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends Tandem>
extends AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

A tandem (serial) queue.

In a tandem queue, a (delegate) job visits all sub-queues once in a predetermined sequence (as determined by the deterministic iteration order over the sub-queues).

Internally, a TandemSimQueueSelector is generated from the sub-queues supplied.

This queue uses the LocalStart model as explained with AbstractSimQueueComposite_LocalStart.

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.

See Also:

TandemSimQueueSelector, CTandem2

Nested Class Summary

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

AbstractSimQueueComposite.RealDelegateJobMapper<J extends SimJob,DJ extends SimJob>

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

AbstractSimEntity.Notifier, AbstractSimEntity.PreNotificationHook

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

SimQueue.AutoRevocationPolicy

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntity

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Field Summary

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

realDelegateJobMapper

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

eventsScheduled, SANITY

Fields inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
Tandem(org.javades.jsimulation.r5.SimEventList eventList, Set<DQ> queues, DelegateSimJobFactory delegateSimJobFactory) Creates a tandem queue given an event list and a list of queues to put in sequence.

Method Summary

Modifier and Type	Method and Description
Tandem<DJ,DQ,J,Q>	getCopySimQueue() Creates a functional copy of this SimQueue.
protected void	processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications) Calls super method (and made final).
protected void	resetEntitySubClass() Calls super method.
String	toStringDefault() Returns "Tandem[queue list]".

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart

getQoS, getQoSClass, getServiceTimeForJob, insertJobInQueueUponArrival, insertJobInQueueUponStart, isStartArmed, queueAccessVacationDropSubClass, removeJobFromQueueUponDeparture, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterArrival, rescheduleAfterDeparture, rescheduleAfterDrop, rescheduleAfterRevokation, rescheduleAfterStart, rescheduleForNewServerAccessCredits, setServerAccessCreditsSubClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

addRealJobLocal, getCopySimQueues, getCopySubSimQueues, getDelegateJob, getDelegateJobMild, getDelegateSimJobFactory, getIndex, getIndex, getQueue, getQueue, getQueues, getRealJob, getRealJob, getSimQueueSelector, isDelegateJob, isRealJob, notifyResetEntity, notifyStateChanged, notifyUpdate, removeJobsFromQueueLocal, resetSimQueueSelector, selectFirstQueue, selectNextQueue, setDelegateSimJobFactory

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

arrive, autoRevoke, cancelDepartureEvent, cancelDepartureEvent, depart, departureFromEventList, drop, getAutoRevocationPolicy, getDepartureEvents, getDepartureEvents, getFirstJob, getFirstJobInServiceArea, getFirstJobInWaitingArea, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, hasJobs, hasJobsInServiceArea, hasJobsInWaitingArea, hasServerAcccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, start, takeServerAccessCredit, triggerPotentialNewStartArmed, unregisterStdOutSimQueueListener

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

addPendingNotification, addPendingNotification, clearAndUnlockPendingNotificationsIfLocked, delegateOperation, doAfterNotifications, doOperation, fireAndLockPendingNotifications, getEventList, getLastUpdateTime, getRegisteredDelegatedOperations, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, notifyEventListReset, registerDelegatedOperation, registerNotificationType, registerOperation, registerPreEventHook, registerPreNotificationHook, registerPreUpdateHook, registerSimEntityListener, registerStdOutSimEntityListener, removeDelegationForOperation, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toString, unregisterSimEntityListener, unregisterStdOutSimEntityListener, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

arrive, getAutoRevocationPolicy, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, revoke, revoke, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntity

doAfterNotifications, doOperation, getEventList, getLastUpdateTime, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, registerSimEntityListener, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, unregisterSimEntityListener, update

Methods inherited from interface org.javades.jsimulation.r5.SimEventListResetListener

notifyEventListReset

Constructor Detail

Tandem

public Tandem(org.javades.jsimulation.r5.SimEventList eventList,
              Set<DQ> queues,
              DelegateSimJobFactory delegateSimJobFactory)

Creates a tandem queue given an event list and a list of queues to put in sequence.

Parameters:

eventList - The event list to use.

queues - The queues, an iteration over the set must return (deterministically) the non-null queues in intended order of visit.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

Throws:

IllegalArgumentException - If the event list is null, the queues argument is null, or if it contains a null entry.

See Also:

DelegateSimJobFactory, DefaultDelegateSimJobFactory

Method Detail

getCopySimQueue

public Tandem<DJ,DQ,J,Q> getCopySimQueue()

Description copied from interface: SimQueue

Creates a functional copy of this SimQueue.

The new object has the same (concrete) type as the original, but starts without jobs and without external listeners. Its initial state must be as if SimEntity.resetEntity() was invoked on the queue.

Note that the semantics of this method are much less strict than the Object.clone () method. Typically, concrete classes will implement this by returning a new SimQueue object. This way, we circumvent the problem of cloning objects with final (for good reasons) fields.

Returns:

A functional copy of this SimQueue.

toStringDefault

public String toStringDefault()

Returns "Tandem[queue list]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimQueue<J extends SimJob,Q extends Tandem>

Returns:

"Tandem[queue list]".

See Also:

SimEntity.setName(java.lang.String), Object.toString()

resetEntitySubClass

protected void resetEntitySubClass()

Calls super method.

Overrides:

resetEntitySubClass in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends Tandem>

See Also:

AbstractSimQueueComposite_LocalStart.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueueComposite_LocalStart.rescheduleAfterRevokation(J, double, boolean), SimEntity.resetEntity()

processSubQueueNotifications

protected final void processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications)

Calls super method (and made final).

Overrides:

processSubQueueNotifications in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends Tandem>

Parameters:

notifications - The sub-queue notifications, will be modified; empty upon return.

See Also:

MultiSimQueueNotificationProcessor, MultiSimQueueNotificationProcessor.Processor, MultiSimQueueNotificationProcessor.setProcessor(org.javades.jqueues.r5.listener.MultiSimQueueNotificationProcessor.Processor), SimEntitySimpleEventType.RESET, SimJQSimpleEventType.ARRIVAL, SimQueueSimpleEventType.QUEUE_ACCESS_VACATION, SimQueueSimpleEventType.QAV_START, SimQueueSimpleEventType.QAV_END, SimQueueSimpleEventType.SERVER_ACCESS_CREDITS, SimQueueSimpleEventType.OUT_OF_SAC, SimQueueSimpleEventType.REGAINED_SAC, SimQueueSimpleEventType.STA_FALSE, SimQueueSimpleEventType.STA_TRUE, SimJQSimpleEventType.DROP, SimJQSimpleEventType.REVOCATION, SimJQSimpleEventType.AUTO_REVOCATION, SimJQSimpleEventType.START, SimJQSimpleEventType.DEPARTURE, AbstractSimEntity.addPendingNotification(java.util.Map<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member, org.javades.jqueues.r5.entity.SimEntityEvent>), SimQueue.arrive(double, J), AbstractSimQueue.start(double, J), AbstractSimQueueComposite.selectNextQueue(double, J, DQ), AbstractSimQueue.depart(double, J), AbstractSimQueue.triggerPotentialNewStartArmed(double), AbstractSimEntity.clearAndUnlockPendingNotificationsIfLocked(), AbstractSimEntity.fireAndLockPendingNotifications()