org.javades.jqueues.r5.listener

Class SimQueueAccessVacationLogger

java.lang.Object

org.javades.jqueues.r5.listener.DefaultSimEntityListener

org.javades.jqueues.r5.listener.DefaultSimJQListener<J,Q>

org.javades.jqueues.r5.listener.DefaultSimQueueListener

org.javades.jqueues.r5.listener.SimQueueAccessVacationLogger

All Implemented Interfaces:

SimQueueListener, SimJQListener, SimEntityListener

public class SimQueueAccessVacationLogger
extends DefaultSimQueueListener

A SimQueueListener that logs queue-access vacations in between resets.

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:

SimEntity.resetEntity(), SimQueue.setQueueAccessVacation(double, boolean), SimEntityListener.notifyResetEntity(org.javades.jqueues.r5.entity.SimEntity), SimQueueListener.notifyStartQueueAccessVacation(double, Q), SimQueueListener.notifyStopQueueAccessVacation(double, Q)

Constructor Summary

Constructors

Constructor and Description
SimQueueAccessVacationLogger()

Method Summary

Modifier and Type	Method and Description
List<Map<Double,Boolean>>	getQueueAccessVacationLog() Returns the queue-access vacation log (unmodifiable).
static boolean	matchQueueAccessVacationLogs(List<Map<Double,Boolean>> predictedQavLogs, List<Map<Double,Boolean>> actualQavLogs, double accuracy, String testString) Compares two queue-access-vacation logs (predicted and actual), and reports inequalities to System.err.
void	notifyResetEntity(SimEntity entity) Does nothing.
void	notifyStartQueueAccessVacation(double time, SimQueue queue) Does nothing.
void	notifyStopQueueAccessVacation(double time, SimQueue queue) Does nothing.

Methods inherited from class org.javades.jqueues.r5.listener.DefaultSimQueueListener

notifyNewStartArmed, notifyOutOfServerAccessCredits, notifyRegainedServerAccessCredits

Methods inherited from class org.javades.jqueues.r5.listener.DefaultSimJQListener

notifyArrival, notifyAutoRevocation, notifyDeparture, notifyDrop, notifyRevocation, notifyStart

Methods inherited from class org.javades.jqueues.r5.listener.DefaultSimEntityListener

notifyStateChanged, notifyUpdate

Methods inherited from class java.lang.Object

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

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

notifyArrival, notifyAutoRevocation, notifyDeparture, notifyDrop, notifyRevocation, notifyStart

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntityListener

notifyStateChanged, notifyUpdate

Constructor Detail

SimQueueAccessVacationLogger

public SimQueueAccessVacationLogger()

Method Detail

getQueueAccessVacationLog

public final List<Map<Double,Boolean>> getQueueAccessVacationLog()

Returns the queue-access vacation log (unmodifiable).

The log is constructed as a list of non-null and unique single-entry maps, corresponding to a reported state change in queue-access vacation. The entry holds the time as its key and the new state of the queue-access vacation as its value.

The queue-access vacation log is automatically cleared upon a (reported) queue reset.

Returns:

The queue-access vacation log (unmodifiable).

See Also:

SimEntityListener.notifyResetEntity(org.javades.jqueues.r5.entity.SimEntity)

notifyResetEntity

public void notifyResetEntity(SimEntity entity)

Description copied from class: DefaultSimEntityListener

Does nothing.

Specified by:

notifyResetEntity in interface SimEntityListener

Overrides:

notifyResetEntity in class DefaultSimEntityListener

Parameters:

entity - The entity that has been reset.

notifyStartQueueAccessVacation

public void notifyStartQueueAccessVacation(double time,
                                           SimQueue queue)

Description copied from class: DefaultSimQueueListener

Does nothing.

Specified by:

notifyStartQueueAccessVacation in interface SimQueueListener

Overrides:

notifyStartQueueAccessVacation in class DefaultSimQueueListener

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setQueueAccessVacation(double, boolean)

notifyStopQueueAccessVacation

public void notifyStopQueueAccessVacation(double time,
                                          SimQueue queue)

Description copied from class: DefaultSimQueueListener

Does nothing.

Specified by:

notifyStopQueueAccessVacation in interface SimQueueListener

Overrides:

notifyStopQueueAccessVacation in class DefaultSimQueueListener

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setQueueAccessVacation(double, boolean)

matchQueueAccessVacationLogs

public static boolean matchQueueAccessVacationLogs(List<Map<Double,Boolean>> predictedQavLogs,
                                                   List<Map<Double,Boolean>> actualQavLogs,
                                                   double accuracy,
                                                   String testString)

Compares two queue-access-vacation logs (predicted and actual), and reports inequalities to System.err.

Parameters:

predictedQavLogs - The predicted queue-access-vacation logs.

actualQavLogs - The actual queue-access-vacation logs.

accuracy - The allowed deviation in key values (times-of-change).

testString - An optional String identifying the test in place.

Returns:

true if the two logs match.

Throws:

IllegalArgumentException - If an argument is null or improperly structured.