ikr.simlib.meters.rate

Class IntervalRateMeter

java.lang.Object

ikr.simlib.meters.rate.IntervalRateMeter

public abstract class IntervalRateMeter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
IntervalRateMeter()

Method Summary

Methods

Modifier and Type	Method and Description
static MessageLengthMeter	create(Duration interval, UnweightedSampleCollector<java.lang.Double> statistic) Helper method to create something which resembles the ShortTermRateMeter, which was included in previous versions of this library.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalRateMeter

public IntervalRateMeter()

Method Detail

create

public static MessageLengthMeter create(Duration interval,
                        UnweightedSampleCollector<java.lang.Double> statistic)

Helper method to create something which resembles the ShortTermRateMeter, which was included in previous versions of this library. Combines a MessageLengthMeter with an IntervalAggregatingStatistic, so that the average rate over an interval is calculated. Unit of measurement is message length units per second.

The returned meter can be connected to one or to multiple ports. If it is connected to multiple ports, the sum rate over all these ports is calculated and written to the statistic.

To resemble the behaviour of the ShortTermRateMeter with the parameter measurePortsIndividually set to true, create multiple of these meters which are backed by a single instance of a statistic.

Parameters:

interval - duration of the averaging interval

statistic - the statistic which is updated with the aggregated values

Returns:

a new meter instance