bst::SoftwareTimer Class Reference

A software timer class for manual control. More...

#include <timer.hpp>

Inheritance diagram for bst::SoftwareTimer:

Collaboration diagram for bst::SoftwareTimer:

Public Member Functions
	SoftwareTimer ()=default
	Default constructor. More...
bool	isDone () const override
	Check if the timer is done. More...
void	reset () override
	Reset the timer - Sets the timer to not done. More...
void	setDone () override
	Set the timer to done. More...
void	setNotDone ()
	Set the timer to not done. More...
void	setTimeout (int timeout_ms) override
	Stubbed out - Does nothing. More...

Private Attributes
bool	is_done_ = false
	The done state of the timer. More...

Detailed Description

A software timer class for manual control.

Constructor & Destructor Documentation

SoftwareTimer()

bst::SoftwareTimer::SoftwareTimer ( )

default

Default constructor.

Member Function Documentation

reset()

void bst::SoftwareTimer::reset ( )

inlineoverridevirtual

Reset the timer - Sets the timer to not done.

Implements bst::ITimer.

References is_done_.

Referenced by TEST().

Here is the caller graph for this function:

isDone()

bool bst::SoftwareTimer::isDone ( ) const

inlineoverridevirtual

Check if the timer is done.

Implements bst::ITimer.

References is_done_.

Referenced by TEST().

Here is the caller graph for this function:

setTimeout()

void bst::SoftwareTimer::setTimeout ( int  timeout_ms )

inlineoverridevirtual

Stubbed out - Does nothing.

Implements bst::ITimer.

setDone()

void bst::SoftwareTimer::setDone ( )

inlineoverridevirtual

Set the timer to done.

Implements bst::ITimer.

References is_done_.

Referenced by TEST().

Here is the caller graph for this function:

setNotDone()

void bst::SoftwareTimer::setNotDone ( )

inline

Set the timer to not done.

References is_done_.

Referenced by TEST().

Here is the caller graph for this function:

Member Data Documentation

is_done_

bool bst::SoftwareTimer::is_done_ = false

private

The done state of the timer.

Referenced by isDone(), reset(), setDone(), and setNotDone().