org.javades.jqueues.r5.misc.example

Class DefaultExampleSimJob<J extends SimJob,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.misc.example.DefaultExampleSimJob<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

public class DefaultExampleSimJob<J extends SimJob,Q extends SimQueue>
extends AbstractSimJob<J,Q>

Implementation of SimJob used (as starting point) in (most of) the examples.

Each job has a public index 'n', set upon construction (n > 0). The requested service time for the job equals its index. This is merely to create interesting examples.

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.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
int	n The index of the job, strictly positive.

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

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
DefaultExampleSimJob(boolean reported, int n) Creates a new DefaultExampleSimJob.

Method Summary

Modifier and Type	Method and Description
double	getServiceTime(SimQueue queue) Returns the index number as service time at given (any non-null) queue, unless the SimJob.getServiceTime(Q) contract orders otherwise.
protected void	resetEntitySubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "DefaultExampleSimJob".

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

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

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

getQoS, getQoSClass

Field Detail

n

public final int n

The index of the job, strictly positive.

Constructor Detail

DefaultExampleSimJob

public DefaultExampleSimJob(boolean reported,
                            int n)

Creates a new DefaultExampleSimJob.

The SimJob created is not attached to a SimEventList (i.e., it does not receive reset events from the event list, nor does it have to; subclasses may override this).

Parameters:

reported - Whether or not this job reports main queue operations to System.out.

n - The index of the job, strictly positive.

Method Detail

getServiceTime

public double getServiceTime(SimQueue queue)

Returns the index number as service time at given (any non-null) queue, unless the SimJob.getServiceTime(Q) contract orders otherwise.

Specified by:

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

Specified by:

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

Parameters:

queue - The queue to visit; any non-null value of the argument returns the index number as requested service time.

Returns:

The index number of this job, or zero if mandated by the SimJob.getServiceTime(Q) contract.

See Also:

SimJob.getQueue()

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method (in order to make implementation final).

Overrides:

resetEntitySubClass in class AbstractSimJob<J extends SimJob,Q extends SimQueue>

See Also:

SimEntity.resetEntity()

toStringDefault

public String toStringDefault()

Returns "DefaultExampleSimJob".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimEntity

Returns:

"DefaultExampleSimJob".

See Also:

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