net.sf.cindy.util
Class Speed

java.lang.Object
  extended by net.sf.cindy.util.Speed

public final class Speed
extends java.lang.Object

Compute speed.

Version:
$id$
Author:
Roger Chen

Method Summary
 void addValue(long value)
          Add value, such as received bytes(unit).
 double getAvgSpeed()
          Get average speed(unit/s).
 long getElapsedTime()
          Get elapsed time(ms).
static Speed getInstance()
          create an instance by default parameter.
static Speed getInstance(int refreshRate, int period)
          create an instance.
 double getSpeed()
          Get current speed(unit/s).
 long getTotalValue()
          Get total value, such as total received bytes(unit).
 void reset()
          Reset all values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static Speed getInstance(int refreshRate,
                                int period)
create an instance.

Parameters:
refreshRate - refresh rate in ms
period - period in ms
Returns:
speed instance

getInstance

public static Speed getInstance()
create an instance by default parameter.

Returns:
speed instance

reset

public void reset()
Reset all values.


addValue

public void addValue(long value)
Add value, such as received bytes(unit).

Parameters:
value - value

getTotalValue

public long getTotalValue()
Get total value, such as total received bytes(unit).

Returns:
total value

getElapsedTime

public long getElapsedTime()
Get elapsed time(ms).

Returns:
elapsed time

getAvgSpeed

public double getAvgSpeed()
Get average speed(unit/s).

Returns:
average speed

getSpeed

public double getSpeed()
Get current speed(unit/s).

Returns:
current speed