org.javades.jqueues.r5.entity.jq.job

Class DefaultSimJob<J extends DefaultSimJob,Q extends SimQueue>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

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

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

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

Type Parameters:

J - The job type.

Q - The queue type for jobs.

All Implemented Interfaces:

SimJob<J,Q>, SimQoS<J,Q>, SimEntity, org.javades.jsimulation.r5.SimEventListResetListener

Direct Known Subclasses:

DefaultSelfListeningSimJob, DefaultSimJobQoS

public class DefaultSimJob<J extends DefaultSimJob,Q extends SimQueue>
extends AbstractSimJob<J,Q>
implements SimJob<J,Q>

A reasonable first-order implementation of SimJob with support for naming, per-queue requested service times and a default service time.

All other methods in this class aim at influencing the result from the SimJob.getServiceTime(Q) implementation.

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:

DefaultSimJobFactory

Nested Class Summary

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

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_FALLBACK_REQUESTED_SERIVE_TIME The default fallback requested service time.

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

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
DefaultSimJob(org.javades.jsimulation.r5.SimEventList eventList, String name, double requestedServiceTime) Creates a new DefaultSimJob with fixed service time request at any SimQueue.
DefaultSimJob(org.javades.jsimulation.r5.SimEventList eventList, String name, Map<Q,Double> requestedServiceTimeMap) Creates a new DefaultSimJob.

Method Summary

Modifier and Type	Method and Description
double	getFallbackRequestedServiceTime() Returns the fallback requested service time, in case a value could not be obtained from the internal mapping of SimQueues onto requested service times.
double	getServiceTime(Q queue) Returns the service-time for this job for a queue visit.
void	setFallbackRequestedServiceTime(double fallbackRequestedServiceTime) Sets the fallback requested service time.
void	setRequestedServiceTimeMappingForQueue(Q queue, double serviceTime) Sets the requested service-time for future visits to a specific queue.

Methods inherited from class org.javades.jqueues.r5.entity.jq.job.AbstractSimJob

getQueue, resetEntitySubClass, setQueue

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, toStringDefault, 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.job.SimJob

getQueue, setQueue

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

Methods inherited from interface org.javades.jqueues.r5.entity.jq.SimQoS

getQoS, getQoSClass

Field Detail

DEFAULT_FALLBACK_REQUESTED_SERIVE_TIME

public static final double DEFAULT_FALLBACK_REQUESTED_SERIVE_TIME

The default fallback requested service time.

This is the value returned by getFallbackRequestedServiceTime() by default, i.e., in absence of invocations of setFallbackRequestedServiceTime(double).

See Also:

Constant Field Values

Constructor Detail

DefaultSimJob

public DefaultSimJob(org.javades.jsimulation.r5.SimEventList eventList,
                     String name,
                     Map<Q,Double> requestedServiceTimeMap)

Creates a new DefaultSimJob.

Note that an internal copy is made of the requestedServiceTimeMap.

Parameters:

eventList - The event list to use, may be null.

name - The name of the new job; may be null.

requestedServiceTimeMap - The requested service time for each key SimQueue, a null key can be used for unlisted SimQueues. If the map is null or no value could be found, getFallbackRequestedServiceTime() is used for the requested service time.

DefaultSimJob

public DefaultSimJob(org.javades.jsimulation.r5.SimEventList eventList,
                     String name,
                     double requestedServiceTime)

Creates a new DefaultSimJob with fixed service time request at any SimQueue.

Sets the fallback requested service time, so actually, you can later change the requested service time through setFallbackRequestedServiceTime(double).

Parameters:

eventList - The event list to use, may be null.

name - The name of the new job; may be null.

requestedServiceTime - The fixed requested service time of this job at any queue.

Throws:

IllegalArgumentException - If the requested service time is (strictly) negative.

Method Detail

getFallbackRequestedServiceTime

public final double getFallbackRequestedServiceTime()

Returns the fallback requested service time, in case a value could not be obtained from the internal mapping of SimQueues onto requested service times.

Returns:

The fallback requested service time, in case a value could not be obtained from the internal mapping of SimQueues onto requested service times.

See Also:

DEFAULT_FALLBACK_REQUESTED_SERIVE_TIME

setFallbackRequestedServiceTime

public final void setFallbackRequestedServiceTime(double fallbackRequestedServiceTime)

Sets the fallback requested service time.

Parameters:

fallbackRequestedServiceTime - The new fallback requested service time.

Throws:

IllegalArgumentException - If the argument is strictly negative.

See Also:

getFallbackRequestedServiceTime()

getServiceTime

public double getServiceTime(Q queue)

Returns the service-time for this job for a queue visit.

For null arguments, this method follows the contract of SimJob.getServiceTime(Q). Otherwise, it inspects the internal mapping of SimQueues onto service times, as explained in DefaultSimJob(org.javades.jsimulation.r5.SimEventList, java.lang.String, double). If the map fails to yield a service time, this method returns the result from getFallbackRequestedServiceTime().

Note that certain SimQueue types may not consult the jobs for the requested service time, but decide it themselves!

Specified by:

getServiceTime in interface SimJob<J extends DefaultSimJob,Q extends SimQueue>

Specified by:

getServiceTime in class AbstractSimJob<J extends DefaultSimJob,Q extends SimQueue>

Parameters:

queue - The SimQueue for which the service time is requested, if null, the service time at the current queue is used, or zero if the job is not currently visiting a queue.

Returns:

The service time at given queue.

See Also:

SimJob.getQueue()

setRequestedServiceTimeMappingForQueue

public void setRequestedServiceTimeMappingForQueue(Q queue,
                                                   double serviceTime)

Sets the requested service-time for future visits to a specific queue.

This method is intended to be used before the job is actually used in a simulation. For instance, note that the setting imposed by this method survives resets of the job.

Parameters:

queue - The queue, non-null.

serviceTime - The requested service time for that queue, zero or positive.

Throws:

IllegalArgumentException - If the queue is null or the requested service time is strictly negative.

IllegalStateException - If the queue is the currently visited queue.

See Also:

getServiceTime(Q), AbstractSimEntity.resetEntity(), AbstractSimJob.getQueue()