ikr.simlib.meters.iat

Class IATMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.OnePointMeter

ikr.simlib.meters.iat.IATMeter

public class IATMeter
extends OnePointMeter

An IAT meter can be attached to a port to measure message interarrival times. 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	IATMeter(UnweightedSampleCollector<Duration> statistic)

Method Summary

Methods

Modifier and Type	Method and Description
static IATMeter	createWithDoubleStatistic(UnweightedSampleCollector<java.lang.Double> statistic) creates a new IATMeter with a statistic that accepts Double values.
static IATMeter	createWithDurationStatistic(UnweightedSampleCollector<Duration> statistic) creates a new IATMeter with a statistic that accepts Duration objects
protected void	evaluateMessage(Message msg, Port port)
protected void	evaluateSample(PointInTime prevMessageTime, PointInTime thisMessageTime) called when a message was seen
protected boolean	useMessage(Message msg) filters messages that should be used for IAT 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

IATMeter

protected IATMeter(UnweightedSampleCollector<Duration> statistic)

Method Detail

createWithDurationStatistic

public static IATMeter createWithDurationStatistic(UnweightedSampleCollector<Duration> statistic)

creates a new IATMeter with a statistic that accepts Duration objects

Parameters:

statistic - statistic to fill with the values

Returns:

the new IATMeter

createWithDoubleStatistic

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

creates a new IATMeter 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 IATMeter

evaluateSample

protected void evaluateSample(PointInTime prevMessageTime,
                  PointInTime thisMessageTime)

called when a message was seen

Parameters:

prevMessageTime - the time the previous message was seen

thisMessageTime - the time this message was seen (now)

useMessage

protected boolean useMessage(Message msg)

filters messages that should be used for IAT measurement

Parameters:

msg - the observed message

evaluateMessage

protected void evaluateMessage(Message msg,
                   Port port)

Specified by:

evaluateMessage in class OnePointMeter