ikr.simlib.meters.rate

Class ShortTermRateMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.OnePointMeter

ikr.simlib.meters.rate.ShortTermRateMeter

All Implemented Interfaces:

PortMonitor

Direct Known Subclasses:

BoundaryRateMeter, DistributionRateMeter

public abstract class ShortTermRateMeter
extends OnePointMeter

This meter measures the short-term data rates on one or more ports to which it is attached. This is done by computing the short-term rate during a given shortTermPeriod. The rates can either be measured individually for each attached port, or they can be measured as an aggregate of all attached ports. This behavior can be selected with the parameter measurePortsIndividually. At the end of each update period, a statistic is updated with either the aggregated throughput, or with all individual throughputs.

DistributionRateMeter and BoundaryRateMeter extend this class to collect the throughput measurements in a DistributionStatistic or in a BoundaryStatistic, respectively.

See Also:

DistributionRateMeter, BoundaryRateMeter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	aggregatedValues
protected java.util.Map<Port,java.lang.Integer>	mapOfAggregatedValues
protected boolean	measurePortsIndividually
protected double	shortTermPeriod
protected double	startOfLastInterval

Fields inherited from class ikr.simlib.meters.Meter

simNode

Constructor Summary

Constructors

Constructor and Description
ShortTermRateMeter(double shortTermPeriod, boolean measurePortsIndividually, java.lang.String name, SimNode parentNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	attachInput(Entity entity, java.lang.String localPortName)
protected void	evaluateMessage(Message msg, Port port)
protected void	updateStatistic(double value)
protected abstract void	updateStatistic(double value, double weight)

Methods inherited from class ikr.simlib.meters.OnePointMeter

attachInput, monitorGetMessage, monitorIsMessageAvailable, monitorMessageIndication

Methods inherited from class java.lang.Object

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

Field Detail

aggregatedValues

protected int aggregatedValues

mapOfAggregatedValues

protected final java.util.Map<Port,java.lang.Integer> mapOfAggregatedValues

startOfLastInterval

protected double startOfLastInterval

shortTermPeriod

protected final double shortTermPeriod

measurePortsIndividually

protected final boolean measurePortsIndividually

Constructor Detail

ShortTermRateMeter

public ShortTermRateMeter(double shortTermPeriod,
                  boolean measurePortsIndividually,
                  java.lang.String name,
                  SimNode parentNode)

Method Detail

evaluateMessage

protected void evaluateMessage(Message msg,
                   Port port)

Specified by:

evaluateMessage in class OnePointMeter

updateStatistic

protected abstract void updateStatistic(double value,
                   double weight)

updateStatistic

protected final void updateStatistic(double value)

attachInput

public void attachInput(Entity entity,
               java.lang.String localPortName)

Overrides:

attachInput in class OnePointMeter