Stopwatch Class Reference

A timer class. More...

#include <Stopwatch.h>

Public Member Functions
	Stopwatch (bool triggered=false)
	~Stopwatch ()=default
manipulators
double	reset ()
	Reset the timer to zero.
void	stop ()
	Stop the timer.
void	start ()
	Start the timer.
void	setTrigger ()
	Stop the timer and set the trigger.
double	getTime ()
	Get elapsed time.
	operator double ()
	Same as getTime()

accessors
bool	isStopped () const
	Check if timer is stopped.
double	getTime () const
	Get elapsed time.
	operator double () const
	Same as getTime() const.

Detailed Description

A timer class.

This class measures time intervals. All time interval measurement should use this class.

Constructor & Destructor Documentation

Stopwatch()

Stopwatch::Stopwatch ( bool triggered = false )

explicit

The default constructor does an implicit reset() or setTrigger(). If triggered == false then the clock starts ticking.

~Stopwatch()

Stopwatch::~Stopwatch ( )

default

Member Function Documentation

getTime() [1/2]

double Stopwatch::getTime

(

)

Get elapsed time.

Returns the time since the last reset() (or calls reset() and returns zero if the trigger is set).

getTime() [2/2]

double Stopwatch::getTime

(

)

const

Get elapsed time.

Returns the time since the last reset(). This cannot trigger the stopwatch to start and will not clear the trigger.

isStopped()

bool Stopwatch::isStopped

(

)

const

Check if timer is stopped.

Returns true if the stopwatch is stopped.

operator double() [1/2]

Stopwatch::operator double

(

)

Same as getTime()

operator double() [2/2]

Stopwatch::operator double

(

)

const

Same as getTime() const.

reset()

double Stopwatch::reset

(

)

Reset the timer to zero.

Set the start time to the current time, returning the time since the last reset. This does not remove the trigger if it's set nor does it start a stopped clock. If the clock is stopped then subsequent reset()'s will return 0.

setTrigger()

void Stopwatch::setTrigger

(

)

Stop the timer and set the trigger.

setTrigger() stops the clock like stop() except there's an implicit start() the next time (non-const) getTime() is called. This is useful when you want the clock to start the first time you check it.

start()

void Stopwatch::start

(

)

Start the timer.

Start the stopwatch. start() removes the trigger, even if the stopwatch was already started.

stop()

void Stopwatch::stop

(

)

Stop the timer.

Stop the stopwatch. The time interval while stopped is not counted by the stopwatch. stop() does not remove the trigger. Has no effect if already stopped.

---

The documentation for this class was generated from the following files:

• src/lib/base/Stopwatch.h
• src/lib/base/Stopwatch.cpp