ikr.simlib.meters.time

Class TimeMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.TwoPointMeter

ikr.simlib.meters.time.TimeMeter

public class TimeMeter
extends TwoPointMeter

A time meter can be attached to to two or more ports to measure message transfer 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.

The figure below depicts the principle of a transfer time meter.

 

 Principle of a transfer time meter
 

Field Summary

Fields inherited from class ikr.simlib.meters.TwoPointMeter

fromPortHandler, toPortHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeMeter(UnweightedSampleCollector<Duration> statistic)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTimeStamp(Message message, PointInTime timeStamp) put from-port time stamp into the map
static TimeMeter	createWithDoubleStatistic(UnweightedSampleCollector<java.lang.Double> statistic) creates a new TimeMeter with a statistic that accepts Double values.
static TimeMeter	createWithDurationStatistic(UnweightedSampleCollector<Duration> statistic) creates a new TimeMeter with a statistic that accepts Duration objects
protected void	evaluateMessageFromPort(Message msg, Port port)
protected void	evaluateMessageToPort(Message msg, Port port)
protected void	evaluateSample(Message msg, PointInTime fromPortTime, PointInTime toPortTime) called when a message was seen at one of the from-ports and at one of the to-ports
protected PointInTime	getAndRemoveTimeStamp(Message message) remove from-port time stamp from the map
protected boolean	useMessage(Message msg) filters messages that should be used for transfer time measurement

Methods inherited from class ikr.simlib.meters.TwoPointMeter

attachFromPort, attachFromPort, attachToPort, attachToPort

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeMeter

protected TimeMeter(UnweightedSampleCollector<Duration> statistic)

Method Detail

createWithDurationStatistic

public static TimeMeter createWithDurationStatistic(UnweightedSampleCollector<Duration> statistic)

creates a new TimeMeter with a statistic that accepts Duration objects

Parameters:

statistic - statistic to fill with the values

Returns:

the new TimeMeter

createWithDoubleStatistic

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

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

addTimeStamp

protected void addTimeStamp(Message message,
                PointInTime timeStamp)

put from-port time stamp into the map

getAndRemoveTimeStamp

protected PointInTime getAndRemoveTimeStamp(Message message)

remove from-port time stamp from the map

evaluateSample

protected void evaluateSample(Message msg,
                  PointInTime fromPortTime,
                  PointInTime toPortTime)

called when a message was seen at one of the from-ports and at one of the to-ports

Parameters:

msg - the message

fromPortTime - the time the message was seen at the from-port

toPortTime - the time the message was seen at the to-port

useMessage

protected boolean useMessage(Message msg)

filters messages that should be used for transfer time measurement

Parameters:

msg - the observed message

evaluateMessageFromPort

protected void evaluateMessageFromPort(Message msg,
                           Port port)

Specified by:

evaluateMessageFromPort in class TwoPointMeter

evaluateMessageToPort

protected void evaluateMessageToPort(Message msg,
                         Port port)

Specified by:

evaluateMessageToPort in class TwoPointMeter