org.javades.jqueues.r5.util.predictor.state

Class DefaultSimQueueState<J extends SimJob,Q extends SimQueue>

java.lang.Object

org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState<J,Q>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

SimQueueState<J,Q>

public class DefaultSimQueueState<J extends SimJob,Q extends SimQueue>
extends Object
implements SimQueueState<J,Q>

A default implementation of SimQueueState.

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 interface	DefaultSimQueueState.PostStartHook<J extends SimJob> A functional interface for a hook to be called right before exiting doStarts(double, java.util.Set<J>).

Constructor Summary

Constructors

Constructor and Description
DefaultSimQueueState(Q queue) Creates a new state object for give queue.

Method Summary

Modifier and Type	Method and Description
void	doArrivals(double time, Set<J> arrivals, Set<JobQueueVisitLog<J,Q>> visitLogs) Adds jobs as arrivals to the queue.
void	doExits(double time, Set<J> drops, Set<J> revocations, Set<J> departures, Set<J> stickers, Set<JobQueueVisitLog<J,Q>> visitLogs) Removes jobs from the queue.
void	doStarts(double time, Set<J> starters) Starts jobs at the queue.
Map<J,Double>	getArrivalTimesMap() Gets a map from jobs present in the queue onto their arrival times.
SimQueueStateHandler	getHandler(String name) Gets a handler by name.
NavigableMap<Double,List<J>>	getJobArrivalsMap() Returns a map of time onto jobs that arrived at that time, and are still present in the queue.
Map<J,Double>	getJobRemainingServiceTimeMap() Gets a map from all jobs in the service area onto their remaining service times.
Set<J>	getJobs() Get the set of all jobs currently residing at the queue, either in the waiting area or in the service area.
Set<J>	getJobsInServiceArea() Get the set of jobs currently in the service area of the queue (i.e., not waiting).
NavigableMap<Double,Set<J>>	getJobsInServiceAreaMap() Returns a map of time onto jobs that started at that time, and are still present (and thus in the service area) in the queue.
Set<J>	getJobsInWaitingArea() Gets a set holding all the jobs waiting at the queue (in no particular order).
Set<J>	getJobsInWaitingAreaOrdered() Gets a set holding all the jobs in the waiting area of the queue, in order of arrival.
Q	getQueue() Gets the queue, non-null.
NavigableMap<Double,List<J>>	getRemainingServiceMap() Returns a map of remaining service time onto jobs that started, have exactly that remaining service time, and are still present (and thus in the service area) in the queue.
int	getServerAccessCredits() Gets the server-access credits.
double	getServiceTime(Q queue, J job) Gets the service time of a job at a queue (central entry point).
Map<J,Double>	getStartTimesMap() Gets a map from all jobs in the service area of this queue onto their start times.
double	getTime() Gets the current time at the queue.
boolean	isQueueAccessVacation() Returns whether or not the queue is on queue-access vacation.
void	registerHandler(SimQueueStateHandler handler) Registers a handler.
void	registerPostStartHook(DefaultSimQueueState.PostStartHook<J> postStartHook, Object userData) Registers a post-start hook.
void	reset() Resets the state, after which it reflects the "real" queue state after a reset.
void	setQueueAccessVacation(double time, boolean start) Starts or ends a queue-access vacation.
void	setServerAccessCredits(double time, int credits) Sets the server-access credits.
void	setServiceTimeProvider(ToDoubleBiFunction<Q,J> serviceTimeProvider) Sets a service-time provider, overruling job-settings for obtaining the required service time for a job visit.
void	setTime(double time) Sets the current time at the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSimQueueState

public DefaultSimQueueState(Q queue)

Creates a new state object for give queue.

Parameters:

queue - The queue, non-null.

Throws:

IllegalArgumentException - If the queue is null.

Method Detail

registerHandler

public final void registerHandler(SimQueueStateHandler handler)

Registers a handler.

A (extension) handler allow for extending the queue-state representation with additional state variables without creating a subclass of DefaultSimQueueState for that (which would lead to problems in case we have multiple such extensions).

Parameters:

handler - The handler.

Throws:

IllegalArgumentException - If the handler or its name are null, or if a handler with the same name has been registered already.

See Also:

SimQueueStateHandler

getHandler

public final SimQueueStateHandler getHandler(String name)

Gets a handler by name.

Parameters:

name - The name to look for.

Returns:

The handler, or null if not found.

getQueue

public final Q getQueue()

Description copied from interface: SimQueueState

Gets the queue, non-null.

The queue to which this SimQueueState refers; cannot be changed.

Specified by:

getQueue in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

The queue, non-null.

reset

public void reset()

Description copied from interface: SimQueueState

Resets the state, after which it reflects the "real" queue state after a reset.

Mimics SimEventList.reset(double). Note that the corresponding SimQueue method is SimEntity.resetEntity().

Implementations must set the time to Double.NaN, effectively meaning "left of" Double.NEGATIVE_INFINITY.

Specified by:

reset in interface SimQueueState<J extends SimJob,Q extends SimQueue>

See Also:

SimEntity.resetEntity()

getTime

public final double getTime()

Description copied from interface: SimQueueState

Gets the current time at the queue.

Specified by:

getTime in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

The current time at the queue.

setTime

public final void setTime(double time)

Description copied from interface: SimQueueState

Sets the current time at the queue.

You cannot set back the time (only through SimQueueState.reset()).

Specified by:

setTime in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The new time.

See Also:

SimQueueState.reset()

isQueueAccessVacation

public final boolean isQueueAccessVacation()

Description copied from interface: SimQueueState

Returns whether or not the queue is on queue-access vacation.

Mimics SimQueue.isQueueAccessVacation().

Specified by:

isQueueAccessVacation in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

Whether or not the queue is on queue-access vacation.

setQueueAccessVacation

public final void setQueueAccessVacation(double time,
                                         boolean start)

Description copied from interface: SimQueueState

Starts or ends a queue-access vacation.

The time cannot be in the past.

Specified by:

setQueueAccessVacation in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The time the vacation starts or ends.

start - Whether to start (true) or end (false) the vacation.

Mimics SimQueue.setQueueAccessVacation(double, boolean).

getJobArrivalsMap

public final NavigableMap<Double,List<J>> getJobArrivalsMap()

Description copied from interface: SimQueueState

Returns a map of time onto jobs that arrived at that time, and are still present in the queue.

Within the list, the jobs are in arrival order. Any job can only be in one of the value lists. The value lists only holds jobs present in the system, and, vice versa, any job present in the system must be in exactly one of the value lists. Null keys or values are not allowed.

Specified by:

getJobArrivalsMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map of time onto jobs that arrived at that time, and are still present in the queue.

getArrivalTimesMap

public final Map<J,Double> getArrivalTimesMap()

Description copied from interface: SimQueueState

Gets a map from jobs present in the queue onto their arrival times.

The key set of this map must be in arrival order.

Every job present in the queue must have an entry, and, vice versa, every entry refers to a job actually present in the queue. Null keys or values are not allowed.

Specified by:

getArrivalTimesMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map from jobs present in the queue onto their arrival times.

getJobs

public final Set<J> getJobs()

Description copied from interface: SimQueueState

Get the set of all jobs currently residing at the queue, either in the waiting area or in the service area.

Jobs are returned in arrival order.

Mimics SimQueue.getJobs().

The default implementation returns the key-set of SimQueueState.getArrivalTimesMap().

Specified by:

getJobs in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

The set of all jobs residing at the queue, non-null.

getJobsInWaitingArea

public final Set<J> getJobsInWaitingArea()

Description copied from interface: SimQueueState

Gets a set holding all the jobs waiting at the queue (in no particular order).

Mimics SimQueue.getJobsInWaitingArea().

The default implementation returns the set difference of SimQueueState.getJobs() and SimQueueState.getJobsInServiceArea().

Specified by:

getJobsInWaitingArea in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A set holding all the jobs waiting at the queue (in no particular order).

getJobsInWaitingAreaOrdered

public final Set<J> getJobsInWaitingAreaOrdered()

Description copied from interface: SimQueueState

Gets a set holding all the jobs in the waiting area of the queue, in order of arrival.

The default implementation returns a LinkedHashSet.

Specified by:

getJobsInWaitingAreaOrdered in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A set holding all the jobs in the waiting area of the queue, in order of arrival.

getServerAccessCredits

public int getServerAccessCredits()

Description copied from interface: SimQueueState

Gets the server-access credits.

Mimics SimQueue.getServerAccessCredits().

Specified by:

getServerAccessCredits in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

The server-access credits.

setServerAccessCredits

public void setServerAccessCredits(double time,
                                   int credits)

Description copied from interface: SimQueueState

Sets the server-access credits.

Mimics SimQueue.setServerAccessCredits(double, int).

The time cannot be in the past.

Specified by:

setServerAccessCredits in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The time to set the credits.

credits - The new remaining server-access credits, non-negative, with Integer.MAX_VALUE treated as infinity.

getStartTimesMap

public final Map<J,Double> getStartTimesMap()

Description copied from interface: SimQueueState

Gets a map from all jobs in the service area of this queue onto their start times.

Specified by:

getStartTimesMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map from all jobs in the service area of this queue onto their start times.

getJobsInServiceAreaMap

public final NavigableMap<Double,Set<J>> getJobsInServiceAreaMap()

Description copied from interface: SimQueueState

Returns a map of time onto jobs that started at that time, and are still present (and thus in the service area) in the queue.

Within the list, the jobs are in start order. Any job can only be in one of the value lists. The value lists only holds jobs currently in the service area of the system, and, vice versa, any job in the service area in the system must be in exactly one of the value lists. Null keys or values are not allowed.

Specified by:

getJobsInServiceAreaMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map of time onto jobs that started at that time, and are still present (and thus in the service area) in the queue.

getJobsInServiceArea

public final Set<J> getJobsInServiceArea()

Description copied from interface: SimQueueState

Get the set of jobs currently in the service area of the queue (i.e., not waiting).

Mimics SimQueue.getJobsInServiceArea().

Specified by:

getJobsInServiceArea in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

The set of jobs currently in the service area of the queue (i.e., not waiting).

getRemainingServiceMap

public final NavigableMap<Double,List<J>> getRemainingServiceMap()

Description copied from interface: SimQueueState

Returns a map of remaining service time onto jobs that started, have exactly that remaining service time, and are still present (and thus in the service area) in the queue.

This map has no equivalence in the bare SimQueue, but the concept is used in, for instance, processor-sharing queues. Implementations must maintain the aggregate value set of the map returned to the set of jobs currently in the service area, and must set the initial key for each job to the result returned from SimJob.getServiceTime(Q).

Within the list, the jobs are in start order. Any job can only be in one of the value lists. The value lists only holds jobs currently in the service area of the system, and, vice versa, any job in the service area must be in exactly one of the value lists. Null keys or values are not allowed.

Specified by:

getRemainingServiceMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map of remaining service time onto jobs that started, have exactly that remaining service time, and are still present (and thus in the service area) in the queue.

getJobRemainingServiceTimeMap

public final Map<J,Double> getJobRemainingServiceTimeMap()

Description copied from interface: SimQueueState

Gets a map from all jobs in the service area onto their remaining service times.

This map has no equivalence in the bare SimQueue, but the concept is used in, for instance, processor-sharing queues. Implementations must maintain the key set of the map returned to the set of jobs currently in the service area, and must set the initial value for each job to the result returned from SimJob.getServiceTime(Q).

Values must be non-negative (but do not have to be decreasing in time!).

Specified by:

getJobRemainingServiceTimeMap in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Returns:

A map from all jobs in the service area onto their remaining service times (non-negative).

getServiceTime

public final double getServiceTime(Q queue,
                                   J job)

Gets the service time of a job at a queue (central entry point).

Parameters:

queue - The queue.

job - The job.

Returns:

The jobs service time, either taken from SimJob.getServiceTime(Q) or from the service-time provider (if installed).

setServiceTimeProvider

public void setServiceTimeProvider(ToDoubleBiFunction<Q,J> serviceTimeProvider)

Sets a service-time provider, overruling job-settings for obtaining the required service time for a job visit.

Parameters:

serviceTimeProvider - The service-time provider; its two arguments are the queue and job, respectively.

doArrivals

public void doArrivals(double time,
                       Set<J> arrivals,
                       Set<JobQueueVisitLog<J,Q>> visitLogs)

Description copied from interface: SimQueueState

Adds jobs as arrivals to the queue.

The arrival time cannot be in the past.

If the queue is on queue-access vacation, the jobs are dropped (i.e., not added to this state object).

Specified by:

doArrivals in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The arrival time.

arrivals - The jobs that arrive.

visitLogs - An optional set of visit log to which entries for dropped jobs (due to queue-access vacations) are added (if the set is non-null).

See Also:

SimQueueState.isQueueAccessVacation()

doStarts

public void doStarts(double time,
                     Set<J> starters)

Description copied from interface: SimQueueState

Starts jobs at the queue.

The start time cannot be in the past.

This method updates the server-access credits, and throws an exception if there are not sufficient server-access credits to start all jobs offered.

Specified by:

doStarts in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The start time.

starters - The jobs that start.

See Also:

SimQueueState.getServerAccessCredits()

doExits

public void doExits(double time,
                    Set<J> drops,
                    Set<J> revocations,
                    Set<J> departures,
                    Set<J> stickers,
                    Set<JobQueueVisitLog<J,Q>> visitLogs)

Description copied from interface: SimQueueState

Removes jobs from the queue.

The removal time cannot be in the past.

Specified by:

doExits in interface SimQueueState<J extends SimJob,Q extends SimQueue>

Parameters:

time - The removal time.

drops - The jobs that drop, may be null.

revocations - The jobs that are revoked, may be null.

departures - The jobs that depart, may be null.

stickers - The jobs that stick (never leave), may be null.

visitLogs - An optional set of visit log to which entries for the leaving jobs are added (if the set is non-null).

registerPostStartHook

public final void registerPostStartHook(DefaultSimQueueState.PostStartHook<J> postStartHook,
                                        Object userData)

Registers a post-start hook.

Parameters:

postStartHook - The hook, non-null.

userData - Optional user-data associated with the hook.

Throws:

IllegalArgumentException - If the hook is null or already registered.

See Also:

SimQueue.AutoRevocationPolicy.UPON_START