org.javades.jqueues.r5.util.stat

Class SimpleSimQueueVisitsStat<J extends SimJob,Q extends SimQueue>

java.lang.Object

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

org.javades.jqueues.r5.util.stat.SimpleSimQueueVisitsStat<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

public class SimpleSimQueueVisitsStat<J extends SimJob,Q extends SimQueue>
extends AbstractSimQueueStat<J,Q>

An concrete class for gathering the most basic visits-related 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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	calculateStatistics(double startTime, double endTime) Calculates all the statistics from the accumulated updates.
double	getAvgSojournTime() Returns the average sojourn time at the queue.
double	getAvgWaitingTime() Returns the average waiting time at the queue.
double	getMaxSojournTime() Returns the maximum sojourn time at the queue.
double	getMaxWaitingTime() Returns the maximum waiting time at the queue.
double	getMinSojournTime() Returns the minimum sojourn time at the queue.
double	getMinWaitingTime() Returns the minimum waiting time at the queue.
int	getNumberOfArrivals() Returns the number of arrivals.
int	getNumberOfAutoRevocations() Returns the number of auto-revoked jobs.
int	getNumberOfDepartures() Returns the number of departures.
int	getNumberOfExits() Returns the number of job exits.
int	getNumberOfJobsDropped() Returns the number of dropped jobs.
int	getNumberOfRevocations() Returns the number of revoked jobs (not auto-revoked).
int	getNumberOfStartedJobs() Returns the number of started jobs.
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	notifyRevocation(double time, J job, Q queue) Does nothing.
void	notifyStart(double time, J job, Q queue) Does nothing.
protected void	resetStatistics() Resets all the statistics.
protected void	updateStatistics(double time, double dt) Updates all the statistics from the state of the queue.

Methods inherited from class org.javades.jqueues.r5.util.stat.AbstractSimQueueStat

calculate, calculate, getLastUpdateTime, getQueue, getStartTime, getStatisticsValid, notifyNewStartArmed, notifyOutOfServerAccessCredits, notifyRegainedServerAccessCredits, notifyResetEntity, notifyStartQueueAccessVacation, notifyStateChanged, notifyStopQueueAccessVacation, notifyUpdate, reset, setQueue, update

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSimQueueVisitsStat

public SimpleSimQueueVisitsStat(Q queue)

Constructor.

Parameters:

queue - The queue to gather statistics from.

SimpleSimQueueVisitsStat

public SimpleSimQueueVisitsStat()

Constructor. The queue property is set to null.

Method Detail

getNumberOfArrivals

public final int getNumberOfArrivals()

Returns the number of arrivals.

Returns:

The number of arrivals.

getNumberOfJobsDropped

public final int getNumberOfJobsDropped()

Returns the number of dropped jobs.

Returns:

The number of dropped jobs.

getNumberOfRevocations

public final int getNumberOfRevocations()

Returns the number of revoked jobs (not auto-revoked).

Returns:

The number of revoked jobs (not auto-revoked).

getNumberOfAutoRevocations

public final int getNumberOfAutoRevocations()

Returns the number of auto-revoked jobs.

Returns:

The number of auto-revoked jobs.

getNumberOfStartedJobs

public final int getNumberOfStartedJobs()

Returns the number of started jobs.

Returns:

The number of started jobs.

getNumberOfDepartures

public final int getNumberOfDepartures()

Returns the number of departures.

Returns:

The number of departures.

getNumberOfExits

public final int getNumberOfExits()

Returns the number of job exits.

Returns:

The number of job exits.

getAvgWaitingTime

public final double getAvgWaitingTime()

Returns the average waiting time at the queue.

The average is taken over all jobs that started.

Returns:

The average waiting time at the queue; Double.NaN in case no job has started (yet).

getAvgSojournTime

public final double getAvgSojournTime()

Returns the average sojourn time at the queue.

The average is taken over all jobs that departed; ignoring jobs that left the queue through other means.

Returns:

The average sojourn time at the queue; Double.NaN in case no job has departed (yet).

getMinWaitingTime

public final double getMinWaitingTime()

Returns the minimum waiting time at the queue.

The minimum is taken over all jobs that started.

Returns:

The minimum waiting time at the queue; Double.NaN in case no job has started (yet).

getMinSojournTime

public final double getMinSojournTime()

Returns the minimum sojourn time at the queue.

The minimum is taken over all jobs that departed; ignoring jobs that left the queue through other means.

Returns:

The minimum sojourn time at the queue; Double.NaN in case no job has departed (yet).

getMaxWaitingTime

public final double getMaxWaitingTime()

Returns the maximum waiting time at the queue.

The maximum is taken over all jobs that started.

Returns:

The maximum waiting time at the queue; Double.NaN in case no job has started (yet).

getMaxSojournTime

public final double getMaxSojournTime()

Returns the maximum sojourn time at the queue.

The maximum is taken over all jobs that departed; ignoring jobs that left the queue through other means.

Returns:

The maximum sojourn time at the queue; Double.NaN in case no job has departed (yet).

resetStatistics

protected void resetStatistics()

Resets all the statistics.

This method must be overridden with a call to super if you want to add performance measures in a subclass. Unfortunately, you must reset the statistics yourself upon construction, because this class avoids the trickery of calling overridable methods from its constructors.

Specified by:

resetStatistics in class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>

updateStatistics

protected void updateStatistics(double time,
                                double dt)

Updates all the statistics from the state of the queue.

This method must be overridden with a call to super if you want to add performance measures in a subclass.

Specified by:

updateStatistics in class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>

Parameters:

time - The actual (new) time.

dt - The time since the last update.

calculateStatistics

protected void calculateStatistics(double startTime,
                                   double endTime)

Calculates all the statistics from the accumulated updates.

This method must be overridden with a call to super if you want to add performance measures in a subclass.

Specified by:

calculateStatistics in class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>

Parameters:

startTime - The start time of the statistics gathering.

endTime - The last time the statistic was updated.

notifyArrival

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

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyArrival in class AbstractSimQueueStat<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)

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyStart in class AbstractSimQueueStat<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)

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyDrop in class AbstractSimQueueStat<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)

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyRevocation in class AbstractSimQueueStat<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)

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyAutoRevocation in class AbstractSimQueueStat<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)

Description copied from class: AbstractSimQueueStat

Does nothing.

Specified by:

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

Overrides:

notifyDeparture in class AbstractSimQueueStat<J extends SimJob,Q extends SimQueue>

Parameters:

time - The (current) time.

job - The job.

queue - The queue.