cpdetector.test
Interface IStopWatch

All Known Implementing Classes:

StopWatchSimple

public interface IStopWatch

Version:

1.2

Author:

Achim Westermann

Method Summary

long	getPureMilliSeconds() Returns the current value of the IStopWatch in ms.
void	reset() This method may serve two purposes: Running- Reset: The m_start- value of the measurement is set to the current time, even if the StopWatch is running.
long	snapShot() This method does not change the state from running to !
boolean	start() Sets the state to running.
boolean	stop() Stops the measurement by assinging current time in ms to the stop value.

Method Detail

start

public boolean start()

Sets the state to running. This allows a call to stop() to make a new measurement by taking the current time. If reset() was invoked before, the m_start - time is set to the return value of System.currentTimeMillis(). Else the old value is preserved. False is returned if a measurement is already in progress. A call to m_start will only m_start a new measurement with the current Time, if it is the first run or reset was called before. Else the time kept after the next call to stop will be the sum of all previous runtimes.

stop

public boolean stop()

Stops the measurement by assinging current time in ms to the stop value. Return true if a valid measurement has been made (StopWatch was running before invoking this method).

reset

public void reset()

This method may serve two purposes:

• Running- Reset:
  The m_start- value of the measurement is set to the current time, even if the StopWatch is running.
• Next- measurement- Reset:
  A flag is set which causes the next call to m_start to delete the old m_start - value.

Note that continuous calls to m_start() and stop() without calling reset will always relate the measurement of time to the first time m_start() was called!

snapShot

public long snapShot()

This method does not change the state from running to !running but performs an update of the overall measurement- data inside. The difference to stop():
After stop() has been called the state is set to !running which causes a new m_start-value to be set during the next call to m_start(). The call to snapShot() does not switch the state. If afterwards m_start() is called, no new value gets assigned to the m_start- value of the StopWatch. Despite of this snapShot Adds the period from the m_start-value to now to the internal total measurement- call. To avoid double - summation of the same time- periods a new m_start- value is set directly.

getPureMilliSeconds

public long getPureMilliSeconds()

Returns the current value of the IStopWatch in ms. This has to be the sum of all previous measurements (circles of m_start()-stop()) not interrupted by calls to reset().