org.perfidix.meter

Class MemMeter

java.lang.Object

org.perfidix.meter.AbstractMeter

org.perfidix.meter.MemMeter

public final class MemMeter
extends AbstractMeter

Meter to bench the amount of memory used by the current Benchmark. Please note that the results of this meter can only be seen as an approximation. Because Perfidix-processes are influencing the used memory as well, a small increasment of used memory is normal. However, because being based only on the Runtime-class of Java, no extraction of the perfidix processes themselves is possible. The MemMeter is only usable with an instance of the Memory enumeration for formatting purposes. This choose must be made by instantiation of the meter.

Author:

Sebastian Graf, University of Konstanz

See Also:

Memory

Constructor Summary

Constructors

Constructor and Description
MemMeter(Memory paramScale) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() A short name of the meter.
String	getUnit() Returns the unit in which this measure taker computes its results.
String	getUnitDescription() The long description of the unit.
double	getValue() Getting the current value for this meter.
int	hashCode()

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

MemMeter

public MemMeter(Memory paramScale)

Constructor.

Parameters:

paramScale - scale for this meter, can be any instance of Memory-enum

Method Detail

getValue

public double getValue()

Getting the current value for this meter.

Specified by:

getValue in class AbstractMeter

Returns:

the current tick value.

getName

public String getName()

A short name of the meter.

Specified by:

getName in class AbstractMeter

Returns:

the name.

getUnit

public String getUnit()

Returns the unit in which this measure taker computes its results.

Specified by:

getUnit in class AbstractMeter

Returns:

the unit of this meter

getUnitDescription

public String getUnitDescription()

The long description of the unit. can be empty but if available, it should provide one or two words about the measure taker.

Specified by:

getUnitDescription in class AbstractMeter

Returns:

the long description of the unit in which measurement takes place.

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractMeter

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractMeter