org.javades.jqueues.r5.extensions.ost

Class SimQueueOSTStateHandler

java.lang.Object

org.javades.jqueues.r5.extensions.ost.SimQueueOSTStateHandler

All Implemented Interfaces:

SimQueueStateHandler

public final class SimQueueOSTStateHandler
extends Object
implements SimQueueStateHandler

A SimQueueStateHandler for maintaining the per-job obtained service time, group the jobs with identical (within a tolerance) service time, and index these groups increasing in their members obtained service times.

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.

Constructor Summary

Constructors

Constructor and Description
SimQueueOSTStateHandler()

Method Summary

Modifier and Type	Method and Description
void	addStartingJob(SimJob job) Adds a starting job to the obtained-service-time administration.
void	addStartingJobs(Set<SimJob> jobs) Adds a set of starting jobs to the obtained-service-time administration.
String	getHandlerName() Returns "SimQueueOSTHandler".
Set<SimJob>	getJobsWithMaximumObtainedServiceTime() Gets all jobs with maximum obtained service time.
Set<SimJob>	getJobsWithMinimumObtainedServiceTime() Gets all jobs with minimum obtained service time.
Set<SimJob>	getJobsWithObtainedServiceTime(double ost) Gets all jobs with given obtained service time.
double	getMaximumObtainedServiceTime() Gets the maximum obtained service time.
double	getMinimumObtainedServiceTime() Gets the minimum obtained service time.
double	getNextHigherThanMinimumObtainedServiceTime() Gets the next-higher-to-minimum obtained service time.
double	getNextLowerThanMaximumObtainedServiceTime() Gets the next-lower-to-maximum obtained service time.
int	getNumberOfOstGroups() Gets the number of groups of jobs with equal obtained service times.
double	getObtainedServiceTime(SimJob job) Gets the obtained service time of given job.
void	increaseMinimumObtainedServiceTime(double time, double delta_ost, boolean mayOvertake, double TOLERANCE) Increases the obtained service time on jobs with the minimum obtained service time.
void	initHandler(DefaultSimQueueState queueState) Initializes the handler, and passes the DefaultSimQueueState object.
boolean	isEmpty() Returns whether this handler has no jobs in its administration.
void	removeJob(SimJob job, boolean mustBePresent) Removes a given job from the obtained-service-time administration.
void	resetHandler(DefaultSimQueueState queueState) Resets the (state represented by) this handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimQueueOSTStateHandler

public SimQueueOSTStateHandler()

Method Detail

getHandlerName

public final String getHandlerName()

Returns "SimQueueOSTHandler".

Specified by:

getHandlerName in interface SimQueueStateHandler

Returns:

"SimQueueOSTHandler".

initHandler

public final void initHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Initializes the handler, and passes the DefaultSimQueueState object.

This method is called only once during registration at the DefaultSimQueueState object.

Specified by:

initHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we register, non-null.

See Also:

DefaultSimQueueState.registerHandler(org.javades.jqueues.r5.util.predictor.state.SimQueueStateHandler)

resetHandler

public void resetHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Resets the (state represented by) this handler.

Specified by:

resetHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we are registered, non-null.

See Also:

SimQueueState.reset(), DefaultSimQueueState.reset()

isEmpty

public final boolean isEmpty()

Returns whether this handler has no jobs in its administration.

Returns:

True if this handler has no jobs in its administration.

getNumberOfOstGroups

public final int getNumberOfOstGroups()

Gets the number of groups of jobs with equal obtained service times.

Returns:

The number of groups of jobs with equal obtained service times.

getObtainedServiceTime

public final double getObtainedServiceTime(SimJob job)

Gets the obtained service time of given job.

Parameters:

job - The job, non-{code null}.

Returns:

The obtained service time of given job.

Throws:

IllegalArgumentException - If the job is null or non-present on the queue.

getMinimumObtainedServiceTime

public final double getMinimumObtainedServiceTime()

Gets the minimum obtained service time.

Returns:

The minimum obtained service time.

Throws:

NoSuchElementException - If the queue is empty.

See Also:

isEmpty()

getNextHigherThanMinimumObtainedServiceTime

public final double getNextHigherThanMinimumObtainedServiceTime()

Gets the next-higher-to-minimum obtained service time.

Returns:

The next-higher-to-minimum obtained service time.

Throws:

NoSuchElementException - If the queue is empty, or if all jobs have equal obtained service-time.

See Also:

isEmpty(), getNumberOfOstGroups()

getMaximumObtainedServiceTime

public final double getMaximumObtainedServiceTime()

Gets the maximum obtained service time.

Returns:

The maximum obtained service time.

Throws:

NoSuchElementException - If the queue is empty.

See Also:

isEmpty()

getNextLowerThanMaximumObtainedServiceTime

public final double getNextLowerThanMaximumObtainedServiceTime()

Gets the next-lower-to-maximum obtained service time.

Returns:

The next-lower-to-maximum obtained service time.

Throws:

NoSuchElementException - If the queue is empty, or if all jobs have equal obtained service-time.

See Also:

isEmpty(), getNumberOfOstGroups()

addStartingJob

public final void addStartingJob(SimJob job)

Adds a starting job to the obtained-service-time administration.

Parameters:

job - The job to add.

Throws:

IllegalArgumentException - If the job is null or already present.

addStartingJobs

public final void addStartingJobs(Set<SimJob> jobs)

Adds a set of starting jobs to the obtained-service-time administration.

Parameters:

jobs - The jobs to add.

Throws:

IllegalArgumentException - If the set is null, or a job in it is null or already present.

See Also:

addStartingJob(org.javades.jqueues.r5.entity.jq.job.SimJob)

removeJob

public final void removeJob(SimJob job,
                            boolean mustBePresent)

Removes a given job from the obtained-service-time administration.

Parameters:

job - The job to remove.

mustBePresent - Whether the job must be present a priori (sanity check).

Throws:

IllegalArgumentException - If the job is null.

IllegalStateException - If the job is unexpectedly absent.

increaseMinimumObtainedServiceTime

public final void increaseMinimumObtainedServiceTime(double time,
                                                     double delta_ost,
                                                     boolean mayOvertake,
                                                     double TOLERANCE)

Increases the obtained service time on jobs with the minimum obtained service time.

Parameters:

time - The current time.

delta_ost - The increase in obtained service time per job.

mayOvertake - Whether the jobs are allowed to overtake other jobs in the ordering of jobs with equal obtained service times.

TOLERANCE - The numerical tolerance in case overtaking is allowed.

Throws:

IllegalArgumentException - If delta_ost < 0 or if an illegal take-over takes place in terms of obtained service times.

IllegalStateException - If there are no jobs present at the queue.

See Also:

isEmpty()

getJobsWithObtainedServiceTime

public final Set<SimJob> getJobsWithObtainedServiceTime(double ost)

Gets all jobs with given obtained service time.

Parameters:

ost - The obtained service time.

Returns:

All jobs with given obtained service time.

Throws:

IllegalArgumentException - If the job is not present at the queue.

getJobsWithMinimumObtainedServiceTime

public final Set<SimJob> getJobsWithMinimumObtainedServiceTime()

Gets all jobs with minimum obtained service time.

Returns:

All jobs with minimum obtained service time.

Throws:

NoSuchElementException - If the queue is empty.

getJobsWithMaximumObtainedServiceTime

public final Set<SimJob> getJobsWithMaximumObtainedServiceTime()

Gets all jobs with maximum obtained service time.

Returns:

All jobs with maximum obtained service time.

Throws:

NoSuchElementException - If the queue is empty.