ikr.simlib.meters

Class TwoPointMeter

java.lang.Object

ikr.simlib.meters.Meter

ikr.simlib.meters.TwoPointMeter

Direct Known Subclasses:

TimeMeter

public abstract class TwoPointMeter
extends Meter

Base class for all meters which are connected to two ports (e.g. transfer time measurement).

Field Summary

Fields

Modifier and Type	Field and Description
protected PortMonitor	fromPortHandler
protected PortMonitor	toPortHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TwoPointMeter()

Method Summary

Methods

Modifier and Type	Method and Description
void	attachFromPort(Entity entity, java.lang.String localPortName) Attaches this meter to the specified port.
void	attachFromPort(Port port) Attaches this meter to the specified port.
void	attachToPort(Entity entity, java.lang.String localPortName) Attaches this meter to the specified port.
void	attachToPort(Port port) Attaches this meter to the specified port.
protected abstract void	evaluateMessageFromPort(Message msg, Port port)
protected abstract void	evaluateMessageToPort(Message msg, Port port)

Methods inherited from class java.lang.Object

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

Field Detail

toPortHandler

protected final PortMonitor toPortHandler

fromPortHandler

protected final PortMonitor fromPortHandler

Constructor Detail

TwoPointMeter

protected TwoPointMeter()

Method Detail

attachFromPort

public void attachFromPort(Entity entity,
                  java.lang.String localPortName)

Attaches this meter to the specified port. All messages traveling accross that port are provided to the meter for it's measurements.

The port is assumed to be a from-port. See the derived meter class for a definition of from-port and to-port.

Parameters:

entity - entity which owns the port

localPortName - port name

attachFromPort

public void attachFromPort(Port port)

Attaches this meter to the specified port. All messages traveling accross that port are provided to the meter for it's measurements.

The port is assumed to be a from-port. See the derived meter class for a definition of from-port and to-port.

Parameters:

port - the port to connect to

attachToPort

public void attachToPort(Entity entity,
                java.lang.String localPortName)

Attaches this meter to the specified port. All messages traveling accross that port are provided to the meter for it's measurements.

The port is assumed to be a to-port. See the derived meter class for a definition of from-port and to-port.

Parameters:

entity - entity which owns the port

localPortName - port name

attachToPort

public void attachToPort(Port port)

Attaches this meter to the specified port. All messages traveling accross that port are provided to the meter for it's measurements.

The port is assumed to be a to-port. See the derived meter class for a definition of from-port and to-port.

Parameters:

port - the port to connect to

evaluateMessageFromPort

protected abstract void evaluateMessageFromPort(Message msg,
                           Port port)

evaluateMessageToPort

protected abstract void evaluateMessageToPort(Message msg,
                         Port port)