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

Class DefaultVisitsLoggingSimJob<J extends DefaultVisitsLoggingSimJob,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>

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

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

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultVisitsLoggingSimJobQoS

public class DefaultVisitsLoggingSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>
extends DefaultSelfListeningSimJob<J,Q>

A DefaultSimJob that logs its SimQueue visits with JobQueueVisitLogs.

Visit-logging jobs play a crucial role in the testing sub-system of SimQueues.

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 inherited from class org.javades.jqueues.r5.entity.jq.job.DefaultSimJob

DEFAULT_FALLBACK_REQUESTED_SERIVE_TIME

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

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
DefaultVisitsLoggingSimJob(org.javades.jsimulation.r5.SimEventList eventList, String name, double requestedServiceTime) Creates a new DefaultVisitsLoggingSimJob.
DefaultVisitsLoggingSimJob(org.javades.jsimulation.r5.SimEventList eventList, String name, Map<Q,Double> requestedServiceTimeMap) Creates a new DefaultVisitsLoggingSimJob.

Method Summary

Modifier and Type	Method and Description
TreeMap<Double,TreeMap<Integer,JobQueueVisitLog>>	getVisitLogs() Returns the JobQueueVisitLogs; indexed by arrival time.
void	notifyArrival(double time, J job, Q queue) Performs sanity checks and administers the event in the visit logs.
void	notifyAutoRevocation(double time, J job, Q queue) Invokes notifyRevocation(double, J, Q).
void	notifyDeparture(double time, J job, Q queue) Performs sanity checks and administers the event in the visit logs.
void	notifyDrop(double time, J job, Q queue) Performs sanity checks and administers the event in the visit logs.
void	notifyResetEntity(SimEntity entity) Does nothing.
void	notifyRevocation(double time, J job, Q queue) Performs sanity checks and administers the event in the visit logs.
void	notifyStart(double time, J job, Q queue) Performs sanity checks and administers the event in the visit logs.
void	notifyStateChanged(double time, SimEntity entity, List<Map<SimEntitySimpleEventType.Member,SimEntityEvent>> notifications) Does nothing.
void	notifyUpdate(double time, SimEntity entity) Does nothing.
void	reset() Clears the visit logs gathered thus far.

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

getFallbackRequestedServiceTime, getServiceTime, setFallbackRequestedServiceTime, setRequestedServiceTimeMappingForQueue

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

Constructor Detail

DefaultVisitsLoggingSimJob

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

Creates a new DefaultVisitsLoggingSimJob.

Parameters:

eventList - The event list.

name - The name.

requestedServiceTimeMap - The requested service-time map.

See Also:

For detailed explanation on the parameters.

DefaultVisitsLoggingSimJob

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

Creates a new DefaultVisitsLoggingSimJob.

Parameters:

eventList - The event list.

name - The name.

requestedServiceTime - The requested service-time.

See Also:

For detailed explanation on the parameters.

Method Detail

getVisitLogs

public final TreeMap<Double,TreeMap<Integer,JobQueueVisitLog>> getVisitLogs()

Returns the JobQueueVisitLogs; indexed by arrival time.

For each arrival time, the consecutive visits are logged as JobQueueVisitLog, bearing in mind that a job can visit multiple queues in sequence at the same instant. Visit counts start with zero.

A new map is created for the outer-level, but no deep-cloning is performed. Hence changes to the visit logs (for instance) will "write though" to the visit logs of this job.

Returns:

The JobQueueVisitLogs; indexed by arrival time.

reset

public final void reset()

Clears the visit logs gathered thus far.

notifyResetEntity

public final void notifyResetEntity(SimEntity entity)

Does nothing.

Specified by:

notifyResetEntity in interface SimEntityListener

Overrides:

notifyResetEntity in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

entity - The entity that has been reset.

notifyUpdate

public final void notifyUpdate(double time,
                               SimEntity entity)

Does nothing.

Specified by:

notifyUpdate in interface SimEntityListener

Overrides:

notifyUpdate in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The time of the update.

entity - The entity that is about to be updated.

See Also:

SimEntityListener.notifyStateChanged(double, org.javades.jqueues.r5.entity.SimEntity, java.util.List<java.util.Map<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member, org.javades.jqueues.r5.entity.SimEntityEvent>>), AbstractSimQueueStat

notifyStateChanged

public final void notifyStateChanged(double time,
                                     SimEntity entity,
                                     List<Map<SimEntitySimpleEventType.Member,SimEntityEvent>> notifications)

Does nothing.

Specified by:

notifyStateChanged in interface SimEntityListener

Overrides:

notifyStateChanged in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The current time (the time of the state change).

entity - The entity at which the state changed.

notifications - The sequence of notifications of state-changes the combination of which led to the new state.

See Also:

SimEntityListener.notifyUpdate(double, org.javades.jqueues.r5.entity.SimEntity)

notifyArrival

public final void notifyArrival(double time,
                                J job,
                                Q queue)

Performs sanity checks and administers the event in the visit logs.

Specified by:

notifyArrival in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyArrival in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.arrive(double, J)

notifyStart

public final void notifyStart(double time,
                              J job,
                              Q queue)

Performs sanity checks and administers the event in the visit logs.

Specified by:

notifyStart in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyStart in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

notifyDrop

public final void notifyDrop(double time,
                             J job,
                             Q queue)

Performs sanity checks and administers the event in the visit logs.

Specified by:

notifyDrop in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyDrop in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

notifyRevocation

public final void notifyRevocation(double time,
                                   J job,
                                   Q queue)

Performs sanity checks and administers the event in the visit logs.

Specified by:

notifyRevocation in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyRevocation in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.revoke(double, J, boolean)

notifyAutoRevocation

public final void notifyAutoRevocation(double time,
                                       J job,
                                       Q queue)

Invokes notifyRevocation(double, J, Q).

Specified by:

notifyAutoRevocation in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyAutoRevocation in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.getAutoRevocationPolicy()

notifyDeparture

public final void notifyDeparture(double time,
                                  J job,
                                  Q queue)

Performs sanity checks and administers the event in the visit logs.

Specified by:

notifyDeparture in interface SimJQListener<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Overrides:

notifyDeparture in class DefaultSelfListeningSimJob<J extends DefaultVisitsLoggingSimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.