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

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

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.feedback.AbstractFeedbackSimQueue<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

Direct Known Subclasses:

FB, FB_p, FB_v

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

Abstract (general) Feedback queue.

Under the hood, a delegate job for each SimJob visits the (single) embedded SimQueue, and upon departing from that queue, the delegate job is optionally fed back to the embedded queue's input. Feedback is controlled through a SimQueueFeedbackController, allowing maximum flexibility. The feedback controller is passed upon construction and cannot be changed afterwards. An internal FeedbackSimQueueSelector is used as SimQueueSelector for the super class.

After the delegate job departs the embedded queue and is not fed back, the "real" job departs from the AbstractFeedbackSimQueue.

This and derived queues use the LocalStart model as explained with AbstractSimQueueComposite_LocalStart. They do, however, inherit their QoS structure from the embedded queue. (This cannot be overruled in subclasses.)

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/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

Modifier	Constructor and Description
protected	AbstractFeedbackSimQueue(org.javades.jsimulation.r5.SimEventList eventList, DQ queue, SimQueueFeedbackController<J,DQ> feedbackController, DelegateSimJobFactory delegateSimJobFactory) Creates an (abstract) feedback queue given an event list, a queue and a feedback controller.

Method Summary

Modifier and Type	Method and Description
SimQueue<DJ,DQ>	getEncapsulatedQueue() Returns the encapsulated queue.
SimQueueFeedbackController<J,DQ>	getFeedbackController() Returns the feedback controller.
Object	getQoS() Returns the QoS value of the encapsulated queue.
Class	getQoSClass() Returns the QoS class of the encapsulated queue.
protected void	processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications) Calls super method (and made final).
protected void	resetEntitySubClass() Calls super method.

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

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, toStringDefault, 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, getCopySimQueue, 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, toStringDefault, unregisterSimEntityListener, update

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

notifyEventListReset

Constructor Detail

AbstractFeedbackSimQueue

protected AbstractFeedbackSimQueue(org.javades.jsimulation.r5.SimEventList eventList,
                                   DQ queue,
                                   SimQueueFeedbackController<J,DQ> feedbackController,
                                   DelegateSimJobFactory delegateSimJobFactory)

Creates an (abstract) feedback queue given an event list, a queue and a feedback controller.

Parameters:

eventList - The event list to use.

queue - The queue, non-null.

feedbackController - The feedback controller, non-null.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

Throws:

IllegalArgumentException - If the event list, queue or feedback controller is null.

See Also:

DelegateSimJobFactory, DefaultDelegateSimJobFactory

Method Detail

getEncapsulatedQueue

public final SimQueue<DJ,DQ> getEncapsulatedQueue()

Returns the encapsulated queue.

Returns:

The encapsulated queue, non-null.

getFeedbackController

public final SimQueueFeedbackController<J,DQ> getFeedbackController()

Returns the feedback controller.

Returns:

The feedback controller, non-null.

getQoS

public final Object getQoS()

Returns the QoS value of the encapsulated queue.

Specified by:

getQoS in interface SimQoS<J extends SimJob,Q extends AbstractFeedbackSimQueue>

Overrides:

getQoS in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractFeedbackSimQueue>

Returns:

The QoS value of the encapsulated queue.

getQoSClass

public final Class getQoSClass()

Returns the QoS class of the encapsulated queue.

Specified by:

getQoSClass in interface SimQoS<J extends SimJob,Q extends AbstractFeedbackSimQueue>

Overrides:

getQoSClass in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractFeedbackSimQueue>

Returns:

The QoS class of the encapsulated queue.

resetEntitySubClass

protected void resetEntitySubClass()

Calls super method.

Note that the SimQueueSelector of this composite queue is reset by our super class. In turn, the selector will reset the embedded SimQueueFeedbackController.

Overrides:

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

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 AbstractFeedbackSimQueue>

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