ikr.simlib.meters.length

Class MessageLengthMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.OnePointMeter

ikr.simlib.meters.length.MessageLengthMeter

public class MessageLengthMeter
extends OnePointMeter

An message length meter can be attached to a port to measure message lengths. The useMessage(Message) method can be overridden to use only those messages for measurement that satisfy certain criteria, e.g., based on message content, or message type.

Field Summary

Fields inherited from class ikr.simlib.meters.OnePointMeter

portHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageLengthMeter(UnweightedSampleCollector<java.lang.Long> statistic)

Method Summary

Methods

Modifier and Type	Method and Description
static MessageLengthMeter	createWithDoubleStatistic(UnweightedSampleCollector<java.lang.Double> statistic) creates a new MessageLengthMeter with a statistic that accepts Double values.
static MessageLengthMeter	createWithLongStatistic(UnweightedSampleCollector<java.lang.Long> statistic) creates a new MessageLengthMeter with a statistic that accepts Long values
protected void	evaluateMessage(Message msg, Port port)
protected void	evaluateSample(Message msg, long length) called when a message was seen
protected boolean	useMessage(Message msg) filters messages that should be used for measurement

Methods inherited from class ikr.simlib.meters.OnePointMeter

attachInput, attachInput

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageLengthMeter

protected MessageLengthMeter(UnweightedSampleCollector<java.lang.Long> statistic)

Method Detail

createWithLongStatistic

public static MessageLengthMeter createWithLongStatistic(UnweightedSampleCollector<java.lang.Long> statistic)

creates a new MessageLengthMeter with a statistic that accepts Long values

Parameters:

statistic - statistic to fill with the values

Returns:

the new MessageLengthMeter

createWithDoubleStatistic

public static MessageLengthMeter createWithDoubleStatistic(UnweightedSampleCollector<java.lang.Double> statistic)

creates a new MessageLengthMeter with a statistic that accepts Double values. The measured durations are converted to seconds and then filled into the statistic.

Parameters:

statistic - statistic to fill with the values

Returns:

the new MessageLengthMeter

evaluateSample

protected void evaluateSample(Message msg,
                  long length)

called when a message was seen

Parameters:

msg - the message

length - the length of the message

useMessage

protected boolean useMessage(Message msg)

filters messages that should be used for measurement

Parameters:

msg - the observed message

evaluateMessage

protected void evaluateMessage(Message msg,
                   Port port)

Specified by:

evaluateMessage in class OnePointMeter