ikr.simlib.meters.count

Class MessageCountMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.OnePointMeter

ikr.simlib.meters.count.MessageCountMeter

public class MessageCountMeter
extends OnePointMeter

An MessageCountMeter can be attached to a port to count messages. The useMessage(Message) method can be overridden to count only those messages 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	MessageCountMeter(UnweightedSampleCollector<java.lang.Void> statistic)

Method Summary

Methods

Modifier and Type	Method and Description
static MessageCountMeter	createWithVoidStatistic(UnweightedSampleCollector<java.lang.Void> statistic) creates a new MessageCountMeter with a statistic that accepts no parameters
protected void	evaluateMessage(Message msg, Port port)
protected void	evaluateSample(Message msg) called when a message was seen
protected boolean	useMessage(Message msg) filters messages that should be used for counting

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

MessageCountMeter

protected MessageCountMeter(UnweightedSampleCollector<java.lang.Void> statistic)

Method Detail

createWithVoidStatistic

public static MessageCountMeter createWithVoidStatistic(UnweightedSampleCollector<java.lang.Void> statistic)

creates a new MessageCountMeter with a statistic that accepts no parameters

Parameters:

statistic - statistic

Returns:

the new MessageCountMeter

evaluateSample

protected void evaluateSample(Message msg)

called when a message was seen

Parameters:

msg - the message

useMessage

protected boolean useMessage(Message msg)

filters messages that should be used for counting

Parameters:

msg - the observed message

evaluateMessage

protected void evaluateMessage(Message msg,
                   Port port)

Specified by:

evaluateMessage in class OnePointMeter