pasco2::Timer Class Reference

#include <pas-co2-pal-timer.hpp>

Inheritance diagram for pasco2::Timer:

Public Member Functions
virtual Error_t	init ()=0
	Initialiazes the timer. More...
virtual Error_t	deinit ()=0
	Deinitialiazes the timer. More...
virtual Error_t	start ()=0
	Starts the timer. More...
virtual Error_t	elapsed (uint32_t &elapsed)=0
	Elapsed time since the timer was started in milliseconds. More...
virtual Error_t	elapsedMicro (uint32_t &elapsed)=0
	Elapsed time since the timer was started in microseconds. More...
virtual Error_t	stop ()=0
	Stops the timer. More...
virtual Error_t	delay (const uint32_t timeout)=0
	Introduces a delay during the specified time. More...

Member Function Documentation

init()

virtual Error_t pasco2::Timer::init ( )

pure virtual

Initialiazes the timer.

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

deinit()

virtual Error_t pasco2::Timer::deinit ( )

pure virtual

Deinitialiazes the timer.

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

start()

virtual Error_t pasco2::Timer::start ( )

pure virtual

Starts the timer.

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

elapsed()

virtual Error_t pasco2::Timer::elapsed ( uint32_t &  elapsed )

pure virtual

Elapsed time since the timer was started in milliseconds.

Parameters

[out]

elapsed

Time in milliseconds

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

elapsedMicro()

virtual Error_t pasco2::Timer::elapsedMicro ( uint32_t &  elapsed )

pure virtual

Elapsed time since the timer was started in microseconds.

Parameters

[out]

elapsed

Time in microseconds

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

stop()

virtual Error_t pasco2::Timer::stop ( )

pure virtual

Stops the timer.

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

delay()

virtual Error_t pasco2::Timer::delay ( const uint32_t  timeout )

pure virtual

Introduces a delay during the specified time.

Parameters

[in]

timeout

Delay time in milliseconds

Returns

PAS CO2 error code

Return values

OK	if success
INIT_ERROR	if error

Implemented in TimerIno.

---

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

• pas-co2-pal-timer.hpp