org.perfidix.meter

Class CountingMeter

java.lang.Object

org.perfidix.meter.AbstractMeter

org.perfidix.meter.CountingMeter

public final class CountingMeter
extends AbstractMeter

Simple meter to count given ticks. The ticks are not resetted afterwards, the

Author:

Alexander Onea, neue Couch, Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
CountingMeter() Constructor, generates a simple CountingMeter.
CountingMeter(String paramName) Constructor with a given name.
CountingMeter(String paramName, String paramUnit) Constructor with a given name and a given unit.
CountingMeter(String paramName, String paramUnit, String paramUnitDesc) Constructor with a given name and a given unit and a given unit description.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Getting the name of this CountingMeter.
String	getUnit() Getting the name of this CountingMeter.
String	getUnitDescription() Getting the description of this CountingMeter.
double	getValue() Getting the value of this CountingMeter.
int	hashCode()
void	tick() The meter is ticking one forward.

Methods inherited from class org.perfidix.meter.AbstractMeter

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CountingMeter

public CountingMeter()

Constructor, generates a simple CountingMeter.

CountingMeter

public CountingMeter(String paramName)

Constructor with a given name.

Parameters:

paramName - the name of this CountingMeter

CountingMeter

public CountingMeter(String paramName,
             String paramUnit)

Constructor with a given name and a given unit.

Parameters:

paramName - the name of this CountingMeter

paramUnit - the unit of this CountingMeter

CountingMeter

public CountingMeter(String paramName,
             String paramUnit,
             String paramUnitDesc)

Constructor with a given name and a given unit and a given unit description.

Parameters:

paramName - the name of this CountingMeter

paramUnit - the unit of this CountingMeter

paramUnitDesc - the description of this CountingMeter

Method Detail

getName

public String getName()

Getting the name of this CountingMeter.

Specified by:

getName in class AbstractMeter

Returns:

the name of this CountingMeter

tick

public void tick()

The meter is ticking one forward.

getValue

public double getValue()

Getting the value of this CountingMeter.

Specified by:

getValue in class AbstractMeter

Returns:

the counter's value.

getUnit

public String getUnit()

Getting the name of this CountingMeter.

Specified by:

getUnit in class AbstractMeter

Returns:

the unit of this CountingMeter

getUnitDescription

public String getUnitDescription()

Getting the description of this CountingMeter.

Specified by:

getUnitDescription in class AbstractMeter

Returns:

the description of this CountingMeter

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractMeter

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractMeter