Stopwatch Class Reference

Stopwatch class. More...

#include <stopwatch.h>

Inheritance diagram for Stopwatch:

Static Public Member Functions
static FORCE_INLINE void	init ()
	Initialize the stopwatch. More...
static bool	stop ()
	Stop the stopwatch. More...
static bool	pause ()
	Pause the stopwatch. More...
static bool	start ()
	Start the stopwatch. More...
static void	resume (const millis_t with_time)
	Resume the stopwatch. More...
static void	reset ()
	Reset the stopwatch. More...
static FORCE_INLINE bool	isRunning ()
	Check if the timer is running. More...
static FORCE_INLINE bool	isPaused ()
	Check if the timer is paused. More...
static millis_t	duration ()
	Get the running time. More...

Detailed Description

Stopwatch class.

This class acts as a timer proving stopwatch functionality including the ability to pause the running time counter.

Member Function Documentation

init()

static FORCE_INLINE void Stopwatch::init ( )

static

Initialize the stopwatch.

{ reset(); }

Here is the call graph for this function:

Here is the caller graph for this function:

stop()

bool Stopwatch::stop ( )

static

Stop the stopwatch.

Stop the running timer, it will silently ignore the request if no timer is currently running.

Returns

true on success

                     {
  #if ENABLED(DEBUG_STOPWATCH)
    Stopwatch::debug(PSTR("stop"));
  #endif
 
  if (isRunning() || isPaused()) {
    #if ENABLED(EXTENSIBLE_UI)
      ExtUI::onPrintTimerStopped();
    #endif
    state = STOPPED;
    stopTimestamp = millis();
    return true;
  }
  else return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pause()

bool Stopwatch::pause ( )

static

Pause the stopwatch.

Pause the running timer, it will silently ignore the request if no timer is currently running.

Returns

true on success

                      {
  #if ENABLED(DEBUG_STOPWATCH)
    Stopwatch::debug(PSTR("pause"));
  #endif
 
  if (isRunning()) {
    #if ENABLED(EXTENSIBLE_UI)
      ExtUI::onPrintTimerPaused();
    #endif
    state = PAUSED;
    stopTimestamp = millis();
    return true;
  }
  else return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

start()

bool Stopwatch::start ( )

static

Start the stopwatch.

Start the timer, it will silently ignore the request if the timer is already running.

Returns

true on success

                      {
  #if ENABLED(DEBUG_STOPWATCH)
    Stopwatch::debug(PSTR("start"));
  #endif
 
  #if ENABLED(EXTENSIBLE_UI)
    ExtUI::onPrintTimerStarted();
  #endif
 
  if (!isRunning()) {
    if (isPaused()) accumulator = duration();
    else reset();
 
    state = RUNNING;
    startTimestamp = millis();
    return true;
  }
  else return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

resume()

void Stopwatch::resume ( const millis_t  with_time )

static

Resume the stopwatch.

Resume a timer from a given duration

                                               {
  #if ENABLED(DEBUG_STOPWATCH)
    Stopwatch::debug(PSTR("resume"));
  #endif
 
  reset();
  if ((accumulator = with_time)) state = RUNNING;
}

Here is the call graph for this function:

reset()

void Stopwatch::reset ( )

static

Reset the stopwatch.

Reset all settings to their default values.

                      {
  #if ENABLED(DEBUG_STOPWATCH)
    Stopwatch::debug(PSTR("reset"));
  #endif
 
  state = STOPPED;
  startTimestamp = 0;
  stopTimestamp = 0;
  accumulator = 0;
}

Here is the caller graph for this function:

isRunning()

static FORCE_INLINE bool Stopwatch::isRunning ( )

static

Check if the timer is running.

Return true if the timer is currently running, false otherwise.

Returns

true if stopwatch is running

{ return state == RUNNING; }

Here is the caller graph for this function:

isPaused()

static FORCE_INLINE bool Stopwatch::isPaused ( )

static

Check if the timer is paused.

Return true if the timer is currently paused, false otherwise.

Returns

true if stopwatch is paused

{ return state == PAUSED; }

Here is the caller graph for this function:

duration()

millis_t Stopwatch::duration ( )

static

Get the running time.

Return the total number of seconds the timer has been running.

Returns

the delta since starting the stopwatch

                             {
  return ((isRunning() ? millis() : stopTimestamp)
          - startTimestamp) / 1000UL + accumulator;
}

Here is the call graph for this function:

Here is the caller graph for this function: