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

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

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>

org.javades.jqueues.r5.entity.jq.queue.composite.feedback.FB<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 FB<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends FB>
extends AbstractFeedbackSimQueue<DJ,DQ,J,Q>

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

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

This queue uses the LocalStart model as explained with AbstractSimQueueComposite_LocalStart.

See AbstractFeedbackSimQueue for more details on the interplay between SimQueueFeedbackController and the embedded FeedbackSimQueueSelector, and how, for instance, reset events are propagated.

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:

AbstractFeedbackSimQueue, FeedbackSimQueueSelector, SimQueueFeedbackController

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
FB(org.javades.jsimulation.r5.SimEventList eventList, DQ queue, SimQueueFeedbackController<J,DQ> feedbackController, DelegateSimJobFactory delegateSimJobFactory) Creates a feedback queue given an event list, a queue and a feedback controller.

Method Summary

Modifier and Type	Method and Description
FB<DJ,DQ,J,Q>	getCopySimQueue() Returns a new FB object on the same SimEventList with a copy of of the encapsulated queue and the same delegate-job factory.
protected void	resetEntitySubClass() Calls super method (and made final).
String	toStringDefault() Returns "FB[embedded queue]".

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

getEncapsulatedQueue, getFeedbackController, getQoS, getQoSClass, processSubQueueNotifications

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

FB

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

Creates a 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

getCopySimQueue

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

Returns a new FB object on the same SimEventList with a copy of of the encapsulated queue and the same delegate-job factory.

Returns:

A new FB object on the same SimEventList with a copy of the encapsulated queue and the same delegate-job factory.

Throws:

UnsupportedOperationException - If the encapsulated queue could not be copied through SimQueue.getCopySimQueue().

See Also:

AbstractSimEntity.getEventList(), AbstractFeedbackSimQueue.getEncapsulatedQueue(), AbstractFeedbackSimQueue.getFeedbackController(), AbstractSimQueueComposite.getDelegateSimJobFactory()

toStringDefault

public String toStringDefault()

Returns "FB[embedded queue]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"FB[embedded queue]".

See Also:

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

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method (and made final).

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 AbstractFeedbackSimQueue<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends FB>

See Also:

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