Timer which countdowns and stops a PostureEstimating::MessageTimer if countdown ends. More...

#include <posture_estimator.h>

Inheritance diagram for PostureEstimating::StopTimer:

Collaboration diagram for PostureEstimating::StopTimer:

Public Member Functions
	StopTimer (MessageTimer *toStop, size_t time)
	Constructor for `PostureEstimating::StopTimer` More...

	~StopTimer ()
	Deconstructor for `PostureEstimating::StopTimer` More...

void	countdown ()
	Starts countdown, stopping `PostureEstimating::MessageTimer` if countdown reached. More...

void	stopCountdown ()
	Stops the countdown and doesn't stop `PostureEstimating::MessageTimer` More...

void	timerEvent ()
	Runs stopCountdown() on `PostureEstimating::MessageTimer` More...

Data Fields
size_t	time
	The time to wait before stopping MessageTimer countdown. More...

bool	running
	Boolen which indicates if timer is running (True = running) More...

Detailed Description

Timer which countdowns and stops a PostureEstimating::MessageTimer if countdown ends.

Constructor & Destructor Documentation

◆ StopTimer()

PostureEstimating::StopTimer::StopTimer	(	MessageTimer *	toStop,
		size_t	time
	)

Constructor for PostureEstimating::StopTimer

Parameters

toStop	`PostureEstimating::MessageTimer` that is stopped when countdown finishes
time	The time countdown runs for before stopping `PostureEstimating::MessageTimer` countdown

◆ ~StopTimer()

PostureEstimating::StopTimer::~StopTimer ( )

Deconstructor for PostureEstimating::StopTimer

Member Function Documentation

◆ countdown()

void PostureEstimating::StopTimer::countdown ( )

Starts countdown, stopping PostureEstimating::MessageTimer if countdown reached.

◆ stopCountdown()

void PostureEstimating::StopTimer::stopCountdown ( )

Stops the countdown and doesn't stop PostureEstimating::MessageTimer

◆ timerEvent()

void PostureEstimating::StopTimer::timerEvent ( void )

Runs stopCountdown() on PostureEstimating::MessageTimer

Field Documentation

◆ running

bool PostureEstimating::StopTimer::running

Initial value:

=

false

Boolen which indicates if timer is running (True = running)

◆ time

size_t PostureEstimating::StopTimer::time

The time to wait before stopping MessageTimer countdown.

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

Public Member Functions

Data Fields