org.javades.jqueues.r5.util.stat

Class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>

java.lang.Object

org.javades.jqueues.r5.util.stat.AbstractSimQueueStat<J,Q>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

SimQueueListener<J,Q>, SimJQListener<J,Q>, SimEntityListener

Direct Known Subclasses:

AutoSimQueueStat, SimpleSimQueueStat, SimpleSimQueueVisitsStat

public abstract class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>
extends Object
implements SimQueueListener<J,Q>

An abstract base class for automatically gathering statistics on a SimQueue.

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:

SimQueueListener

Constructor Summary

Constructors

Constructor and Description
AbstractSimQueueStat() Constructor.
AbstractSimQueueStat(Q queue) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	calculate()
protected void	calculate(double time) Calculates all statistics (if invalid) and marks them valid.
protected abstract void	calculateStatistics(double startTime, double endTime) Calculates all the statistics from the accumulated updates.
double	getLastUpdateTime() Returns the time of the last update.
Q	getQueue() Gets the SimQueue we are gathering statistics on.
double	getStartTime() Gets the start time for gathering statistics.
boolean	getStatisticsValid() Checks if the statistics are valid.
void	notifyArrival(double time, J job, Q queue) Does nothing.
void	notifyAutoRevocation(double time, J job, Q queue) Does nothing.
void	notifyDeparture(double time, J job, Q queue) Does nothing.
void	notifyDrop(double time, J job, Q queue) Does nothing.
void	notifyNewStartArmed(double time, Q queue, boolean startArmed) Does nothing.
void	notifyOutOfServerAccessCredits(double time, Q queue) Does nothing.
void	notifyRegainedServerAccessCredits(double time, Q queue) Does nothing.
void	notifyResetEntity(SimEntity entity) Invokes reset().
void	notifyRevocation(double time, J job, Q queue) Does nothing.
void	notifyStart(double time, J job, Q queue) Does nothing.
void	notifyStartQueueAccessVacation(double time, Q queue) Does nothing.
void	notifyStateChanged(double time, SimEntity entity, List<Map<SimEntitySimpleEventType.Member,SimEntityEvent>> notifications) Does nothing.
void	notifyStopQueueAccessVacation(double time, Q queue) Does nothing.
void	notifyUpdate(double time, SimEntity entity) Checks the queue argument and invokes update(double).
void	reset() Resets all statistics and start a new batch of statistics gathering.
protected abstract void	resetStatistics() Resets all the statistics.
void	setQueue(Q queue) Sets the SimQueue we are gathering statistics on.
protected void	update(double time) Updates all statistics at given time.
protected abstract void	updateStatistics(double time, double dt) Updates all the statistics from the state of the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSimQueueStat

public AbstractSimQueueStat(Q queue)

Constructor.

Parameters:

queue - The queue to gather statistics from.

AbstractSimQueueStat

public AbstractSimQueueStat()

Constructor. The queue property is set to null.

Method Detail

resetStatistics

protected abstract void resetStatistics()

Resets all the statistics. All other required internal bookkeeping has already been taken care of. Unfortunately, you must reset the statistics yourself upon construction, because this class avoids the trickery of calling override-able methods from its constructors.

updateStatistics

protected abstract void updateStatistics(double time,
                                         double dt)

Updates all the statistics from the state of the queue. All other required internal bookkeeping has already been taken care of.

Parameters:

time - The actual (new) time.

dt - The time since the last update.

calculateStatistics

protected abstract void calculateStatistics(double startTime,
                                            double endTime)

Calculates all the statistics from the accumulated updates. All other required internal bookkeeping has already been taken care of.

Parameters:

startTime - The start time of the statistics gathering.

endTime - The last time the statistic was updated.

reset

public void reset()

Resets all statistics and start a new batch of statistics gathering.

The start time is set to the current time (the time on the event list of the queue, or minus infinity if no queue is present), all statistics are invalidated and prepared for the new batch.

Only override this method with a call to super if you have special actions to be performed upon a reset other than resetting statistics. Otherwise, override resetStatistics().

See Also:

getLastUpdateTime(), resetStatistics(), getStatisticsValid()

update

protected void update(double time)

Updates all statistics at given time. Note that updates timed before our latest update yield an exception.

Only override this method with a call to super if you have special actions to be performed upon an update other than updating statistics. Otherwise, override updateStatistics(double, double).

Parameters:

time - The (new) current time.

Throws:

IllegalArgumentException - If the time is in the past (i.e., strictly smaller than our last update time).

calculate

protected void calculate(double time)

Calculates all statistics (if invalid) and marks them valid. This method is automatically invoked by all statistics getters.

Only override this method with a call to super if you have special actions to be performed upon a calculation other than calculating statistics. Otherwise, override calculateStatistics(double, double).

Parameters:

time - The current time, may be beyond the last update time.

calculate

protected void calculate()

getQueue

public final Q getQueue()

Gets the SimQueue we are gathering statistics on.

Returns:

The SimQueue we are gathering statistics on.

See Also:

setQueue(Q)

setQueue

public void setQueue(Q queue)

Sets the SimQueue we are gathering statistics on. This methods always invokes reset().

Override this method is discouraged, even with a call to super. Also, an internal version of this method is used upon object construction.

Parameters:

queue - The new queue to monitor (may be null).

See Also:

getQueue(), SimEntity.registerSimEntityListener(org.javades.jqueues.r5.entity.SimEntityListener), SimEntity.unregisterSimEntityListener(org.javades.jqueues.r5.entity.SimEntityListener), reset()

getStartTime

public final double getStartTime()

Gets the start time for gathering statistics.

Returns:

The start time for gathering statistics.

getLastUpdateTime

public final double getLastUpdateTime()

Returns the time of the last update.

Returns:

The time of the last update.

See Also:

update(double), notifyUpdate(double, SimEntity)

getStatisticsValid

public final boolean getStatisticsValid()

Checks if the statistics are valid.

Returns:

True if the statistics are valid.

See Also:

calculate(double)

notifyResetEntity

public void notifyResetEntity(SimEntity entity)

Invokes reset().

Specified by:

notifyResetEntity in interface SimEntityListener

Parameters:

entity - The entity that has been reset.

notifyUpdate

public void notifyUpdate(double time,
                         SimEntity entity)

Checks the queue argument and invokes update(double).

Specified by:

notifyUpdate in interface SimEntityListener

Parameters:

time - The time of the update.

entity - The entity that is about to be updated.

Throws:

IllegalArgumentException - If the queue is null or not the queue we monitor.

See Also:

getQueue()

notifyStateChanged

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

Does nothing.

Specified by:

notifyStateChanged in interface SimEntityListener

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 void notifyArrival(double time,
                          J job,
                          Q queue)

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.arrive(double, J)

notifyStart

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

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

notifyDrop

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

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

notifyRevocation

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

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.revoke(double, J, boolean)

notifyAutoRevocation

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

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

See Also:

SimQueue.getAutoRevocationPolicy()

notifyDeparture

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

Does nothing.

Specified by:

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

Parameters:

time - The (current) time.

job - The job.

queue - The queue.

notifyNewStartArmed

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

Does nothing.

Specified by:

notifyNewStartArmed in interface SimQueueListener<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

queue - The queue.

startArmed - The new startArmed state.

See Also:

SimQueue.isStartArmed()

notifyStartQueueAccessVacation

public void notifyStartQueueAccessVacation(double time,
                                           Q queue)

Does nothing.

Specified by:

notifyStartQueueAccessVacation in interface SimQueueListener<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setQueueAccessVacation(double, boolean)

notifyStopQueueAccessVacation

public void notifyStopQueueAccessVacation(double time,
                                          Q queue)

Does nothing.

Specified by:

notifyStopQueueAccessVacation in interface SimQueueListener<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setQueueAccessVacation(double, boolean)

notifyOutOfServerAccessCredits

public void notifyOutOfServerAccessCredits(double time,
                                           Q queue)

Does nothing.

Specified by:

notifyOutOfServerAccessCredits in interface SimQueueListener<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

queue - The queue.

See Also:

SimQueue.setServerAccessCredits(double, int)

notifyRegainedServerAccessCredits

public void notifyRegainedServerAccessCredits(double time,
                                              Q queue)

Does nothing.

Specified by:

notifyRegainedServerAccessCredits in interface SimQueueListener<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

queue - The queue.