org.javades.jqueues.r5.listener

Class SimQueueServerAccessCreditsAvailabilityLogger

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

All Implemented Interfaces:

SimQueueListener, SimJQListener, SimEntityListener

public class SimQueueServerAccessCreditsAvailabilityLogger
extends DefaultSimQueueListener

A SimQueueListener that logs server-access-credits availability 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.setServerAccessCredits(double, int), SimEntityListener.notifyResetEntity(org.javades.jqueues.r5.entity.SimEntity), SimQueueListener.notifyOutOfServerAccessCredits(double, Q), SimQueueListener.notifyRegainedServerAccessCredits(double, Q)

Constructor Summary

Constructors

Constructor and Description
SimQueueServerAccessCreditsAvailabilityLogger()

Method Summary

Modifier and Type	Method and Description
List<Map<Double,Boolean>>	getServerAccessCreditsAvailabilityLog() Returns the server-access-credits availability log (unmodifiable).
static boolean	matchServerAccessCreditsAvailabilityLogs(List<Map<Double,Boolean>> predictedSacLogs, List<Map<Double,Boolean>> actualSacLogs, double accuracy, String testString) Compares two server-access-credits availability logs (predicted and actual), and reports inequalities to System.err.
void	notifyOutOfServerAccessCredits(double time, SimQueue queue) Does nothing.
void	notifyRegainedServerAccessCredits(double time, SimQueue queue) Does nothing.
void	notifyResetEntity(SimEntity entity) Does nothing.

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

notifyNewStartArmed, 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

SimQueueServerAccessCreditsAvailabilityLogger

public SimQueueServerAccessCreditsAvailabilityLogger()

Method Detail

getServerAccessCreditsAvailabilityLog

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

Returns the server-access-credits availability log (unmodifiable).

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

The server-access-credits availability log is automatically cleared upon a (reported) queue reset.

Returns:

The server-access-credits availability 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.

notifyRegainedServerAccessCredits

public void notifyRegainedServerAccessCredits(double time,
                                              SimQueue queue)

Description copied from class: DefaultSimQueueListener

Does nothing.

Specified by:

notifyRegainedServerAccessCredits in interface SimQueueListener

Overrides:

notifyRegainedServerAccessCredits in class DefaultSimQueueListener

Parameters:

time - The (current) time.

queue - The queue.

notifyOutOfServerAccessCredits

public void notifyOutOfServerAccessCredits(double time,
                                           SimQueue queue)

Description copied from class: DefaultSimQueueListener

Does nothing.

Specified by:

notifyOutOfServerAccessCredits in interface SimQueueListener

Overrides:

notifyOutOfServerAccessCredits in class DefaultSimQueueListener

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setServerAccessCredits(double, int)

matchServerAccessCreditsAvailabilityLogs

public static boolean matchServerAccessCreditsAvailabilityLogs(List<Map<Double,Boolean>> predictedSacLogs,
                                                               List<Map<Double,Boolean>> actualSacLogs,
                                                               double accuracy,
                                                               String testString)

Compares two server-access-credits availability logs (predicted and actual), and reports inequalities to System.err.

Parameters:

predictedSacLogs - The predicted server-access-credits availability logs.

actualSacLogs - The actual server-access-credits availability 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.