Fawkes API  Fawkes Development Version
fawkes::Watch Class Reference

This is a stop-watch. More...

#include <>>

Public Member Functions

 Watch (Clock *clock)
 Constructor. More...
 
virtual ~Watch ()
 Destructor. More...
 
void start (Time *t=0)
 Starts the watch. More...
 
void stop (Time *t=0)
 Stops the watch. More...
 
void pause (Time *t=0)
 Pauses the watch. More...
 
void reset ()
 Reset time. More...
 
Time watch_time ()
 Returns the current watch time. More...
 
Time clock_time ()
 Returns the current clock time. More...
 

Detailed Description

This is a stop-watch.

Also, one can request the current time from the clock. Every watch counts time w.r.t. a certain time source.

Author
Daniel Beck

Definition at line 31 of file watch.h.

Constructor & Destructor Documentation

◆ Watch()

fawkes::Watch::Watch ( Clock clock)

Constructor.

Parameters
clockclock instance to use for measurement.

Definition at line 40 of file watch.cpp.

◆ ~Watch()

fawkes::Watch::~Watch ( )
virtual

Destructor.

Definition at line 51 of file watch.cpp.

Member Function Documentation

◆ clock_time()

Time fawkes::Watch::clock_time ( )

Returns the current clock time.

Returns
the current clock time

Definition at line 183 of file watch.cpp.

References fawkes::Clock::get_time().

◆ pause()

void fawkes::Watch::pause ( Time t = 0)

Pauses the watch.

Puts the watch into pause mode

Parameters
tthe time at which the watch is started is written to this time object

Definition at line 123 of file watch.cpp.

References fawkes::Clock::get_time(), and fawkes::Time::set_time().

◆ reset()

void fawkes::Watch::reset ( void  )

Reset time.

Definition at line 141 of file watch.cpp.

References fawkes::Clock::get_time(), and fawkes::Time::set_time().

◆ start()

void fawkes::Watch::start ( Time t = 0)

Starts the watch.

This starts the watch. In case it is paused, currently, the watch is restarted

Parameters
tthe time at which the watch is started is written to this time object

Definition at line 62 of file watch.cpp.

References fawkes::Clock::get_time(), and fawkes::Time::set_time().

◆ stop()

void fawkes::Watch::stop ( Time t = 0)

Stops the watch.

This stops the watch also when it is paused, currently

Parameters
tthe time at which the watch is started is written to this time object

Definition at line 97 of file watch.cpp.

References fawkes::Clock::get_time(), and fawkes::Time::set_time().

◆ watch_time()

Time fawkes::Watch::watch_time ( )

Returns the current watch time.

Returns
the current watch time

Definition at line 153 of file watch.cpp.

References fawkes::Clock::get_time().


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