org.javades.jqueues.r5.listener

Class SimQueueStartArmedLogger

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

All Implemented Interfaces:

SimQueueListener, SimJQListener, SimEntityListener

public class SimQueueStartArmedLogger
extends DefaultSimQueueListener

A SimQueueListener that logs StartArmed 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(), SimEntityListener.notifyResetEntity(org.javades.jqueues.r5.entity.SimEntity), SimQueueListener.notifyNewStartArmed(double, Q, boolean)

Constructor Summary

Constructors

Constructor and Description
SimQueueStartArmedLogger()

Method Summary

Modifier and Type	Method and Description
List<Map<Double,Boolean>>	getStartArmedLog() Returns the StartArmed log (unmodifiable).
static boolean	matchStartArmedLogs(List<Map<Double,Boolean>> predictedStaLogs, List<Map<Double,Boolean>> actualStaLogs, double accuracy, String testString) Compares two StartArmed logs (predicted and actual), and reports inequalities to System.err.
void	notifyNewStartArmed(double time, SimQueue queue, boolean startArmed) Does nothing.
void	notifyResetEntity(SimEntity entity) Does nothing.

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

notifyOutOfServerAccessCredits, notifyRegainedServerAccessCredits, notifyStartQueueAccessVacation, notifyStopQueueAccessVacation

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

SimQueueStartArmedLogger

public SimQueueStartArmedLogger()

Method Detail

getStartArmedLog

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

Returns the StartArmed log (unmodifiable).

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

The StartArmed log is automatically cleared upon a (reported) queue reset.

Returns:

The StartArmed 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.

notifyNewStartArmed

public void notifyNewStartArmed(double time,
                                SimQueue queue,
                                boolean startArmed)

Description copied from class: DefaultSimQueueListener

Does nothing.

Specified by:

notifyNewStartArmed in interface SimQueueListener

Overrides:

notifyNewStartArmed in class DefaultSimQueueListener

Parameters:

time - The (current) time.

queue - The queue.

startArmed - The new startArmed state.

See Also:

SimQueue.isStartArmed()

matchStartArmedLogs

public static boolean matchStartArmedLogs(List<Map<Double,Boolean>> predictedStaLogs,
                                          List<Map<Double,Boolean>> actualStaLogs,
                                          double accuracy,
                                          String testString)

Compares two StartArmed logs (predicted and actual), and reports inequalities to System.err.

In case of a mismatch, the method re-attempts with a compacted version (dealing with simultaneous notifications) of the predicted logs, because some SimQueuePredictor implementations cannot always provide atomic StartArmed notifications. A warning on System.err is given in case erroneous notifications are found in the predicted logs.

Parameters:

predictedStaLogs - The predicted StartArmed logs.

actualStaLogs - The actual StartArmed 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.