Timer Class Reference

The Timer class provides a countdown timer with start, pause, resume, reset, and time adjustment functionalities. More...

#include <Timer.hpp>

Collaboration diagram for Timer:

Public Member Functions
	Timer (int hours, int minutes, int seconds)
	Constructor to specify the timer duration directly in hours, minutes, and seconds. More...
void	start (int countdownMilliseconds)
	Starts the timer by setting the end time based on the current time plus the countdown duration. More...
void	pause ()
	Pauses the timer and calculates the remaining milliseconds. More...
void	resume ()
	Resumes the timer from where it was paused by recalculating the end time. More...
void	reset ()
	Resets the timer to its original duration and pauses it. More...
void	addTime (int seconds)
	Adds a specified amount of time (in seconds) to the timer. More...
bool	isRunning ()
	Checks if the timer is currently running. More...
bool	isDone ()
int	remainingMilliseconds ()
	Returns the remaining time in milliseconds. More...
double	percentElapsed ()
	Returns the percentage of time that has elapsed since the timer started. More...

Private Attributes
int	_startMilliseconds
	The initial duration of the timer in milliseconds. More...
int	_countdownMilliseconds
	The duration of the countdown in milliseconds. More...
int	_remainingMilliseconds
	The remaining time in milliseconds. More...
int	_incrementMilliseconds
	The increment time in milliseconds for adding time. More...
bool	_running
	Indicates whether the timer is currently running. More...
chrono::time_point< chrono::steady_clock >	_endTime
	The time point when the timer will end. More...
chrono::time_point< chrono::steady_clock >	_pauseTime
	The time point when the timer was paused. More...

Detailed Description

The Timer class provides a countdown timer with start, pause, resume, reset, and time adjustment functionalities.

Definition at line 12 of file Timer.hpp.

Constructor & Destructor Documentation

Timer()

Timer::Timer	(	int	hours,
		int	minutes,
		int	seconds
	)

Constructor to specify the timer duration directly in hours, minutes, and seconds.

Initializes and starts the timer with the specified duration.

Parameters

hours	The number of hours to set.
minutes	The number of minutes to set.
seconds	The number of seconds to set.

Definition at line 19 of file Timer.cpp.

                                                {
    int milli = 3600000 * hours + 60000 * minutes + 1000 * seconds;
    if (milli >= 360000000) { milli = 359999999; }
    _countdownMilliseconds = milli;
    _remainingMilliseconds = milli;
    _startMilliseconds = milli;
    _incrementMilliseconds = 0;
    start(_countdownMilliseconds);
}

Member Function Documentation

addTime()

void Timer::addTime

(

int

seconds

)

Adds a specified amount of time (in seconds) to the timer.

If the timer is running, it resumes after adding time.

Parameters

seconds

The number of seconds to add to the timer.

Definition at line 95 of file Timer.cpp.

                               {
    bool wasRunning = _running;
    pause();
    
    _remainingMilliseconds += 1000 * seconds;
    _countdownMilliseconds += 1000 * seconds;

    if(wasRunning){
        resume();
    }
}

isDone()

bool Timer::isDone

(

)

Definition at line 147 of file Timer.cpp.

Referenced by Display::tickTimer().

                   {
    return !_running && !remainingMilliseconds();
}

Here is the caller graph for this function:

isRunning()

bool Timer::isRunning

(

)

Checks if the timer is currently running.

Returns

bool True if the timer is running, false otherwise.

Definition at line 143 of file Timer.cpp.

Referenced by Menu::checkTimerInput(), and Display::tickTimer().

                      {
    return _running;
}

Here is the caller graph for this function:

pause()

void Timer::pause

(

)

Pauses the timer and calculates the remaining milliseconds.

Definition at line 50 of file Timer.cpp.

Referenced by Menu::checkTimerInput().

                  {
    if (_running) {
       _pauseTime = chrono::steady_clock::now();
       _remainingMilliseconds = chrono::duration_cast<chrono::milliseconds>(_endTime - _pauseTime).count();
       _running = false;
    }
}

Here is the caller graph for this function:

percentElapsed()

double Timer::percentElapsed

(

)

Returns the percentage of time that has elapsed since the timer started.

Returns

double The percentage of time elapsed.

Definition at line 160 of file Timer.cpp.

Referenced by Display::tickTimer().

                             {
    int start = 0;
    if (_remainingMilliseconds > _startMilliseconds) {
        start = _remainingMilliseconds;
    } else {
        start = _startMilliseconds;
    }
    if (start == 0) { 
        return 100.0; 
    }

    int elapsedMilliseconds = start - remainingMilliseconds();
    double percentage = ((double)(elapsedMilliseconds) / start) * 100;
    return percentage;
}

Here is the caller graph for this function:

remainingMilliseconds()

int Timer::remainingMilliseconds

(

)

Returns the remaining time in milliseconds.

If the timer has expired, it returns 0.

Returns

int The remaining time in milliseconds.

Definition at line 118 of file Timer.cpp.

Referenced by Menu::checkTimerInput(), Display::tickTimer(), and Menu::timerSequence().

                                 {
    if (_running) {
        auto now = chrono::steady_clock::now();
        auto remaining = chrono::duration_cast<chrono::milliseconds>(_endTime - now).count();
        if (remaining > 0) { 
            return remaining; 
        } else { 
            _running = false; 
            _remainingMilliseconds = 0; 
            return 0; 
        }
    } else {
        return _remainingMilliseconds;
    }
}

Here is the caller graph for this function:

reset()

void Timer::reset

(

)

Resets the timer to its original duration and pauses it.

Definition at line 78 of file Timer.cpp.

Referenced by Menu::checkTimerInput().

                  {
    pause();
    _remainingMilliseconds = _startMilliseconds;
    _countdownMilliseconds = _startMilliseconds;
}

Here is the caller graph for this function:

resume()

void Timer::resume

(

)

Resumes the timer from where it was paused by recalculating the end time.

Definition at line 65 of file Timer.cpp.

Referenced by Menu::checkTimerInput().

                   {
    if (!_running) {
        _endTime = chrono::steady_clock::now() + chrono::milliseconds(_remainingMilliseconds);
        _running = true;
    }
}

Here is the caller graph for this function:

start()

void Timer::start

(

int

countdownMilliseconds

)

Starts the timer by setting the end time based on the current time plus the countdown duration.

Parameters

countdownMilliseconds

The duration for the countdown in milliseconds.

Definition at line 38 of file Timer.cpp.

                                           {
    _running = true;
    _endTime = chrono::steady_clock::now() + chrono::milliseconds(_countdownMilliseconds);
}

Field Documentation

_countdownMilliseconds

int Timer::_countdownMilliseconds

private

The duration of the countdown in milliseconds.

Definition at line 84 of file Timer.hpp.

_endTime

chrono::time_point<chrono::steady_clock> Timer::_endTime

private

The time point when the timer will end.

Definition at line 90 of file Timer.hpp.

_incrementMilliseconds

int Timer::_incrementMilliseconds

private

The increment time in milliseconds for adding time.

Definition at line 86 of file Timer.hpp.

_pauseTime

chrono::time_point<chrono::steady_clock> Timer::_pauseTime

private

The time point when the timer was paused.

Definition at line 91 of file Timer.hpp.

_remainingMilliseconds

int Timer::_remainingMilliseconds

private

The remaining time in milliseconds.

Definition at line 85 of file Timer.hpp.

_running

bool Timer::_running

private

Indicates whether the timer is currently running.

Definition at line 88 of file Timer.hpp.

_startMilliseconds

int Timer::_startMilliseconds

private

The initial duration of the timer in milliseconds.

Definition at line 83 of file Timer.hpp.

---

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

• include/Timer.hpp
• src/Timer.cpp