HallSpeed::Timer Class Reference

#include <hall-pal-timer.hpp>

Inheritance diagram for HallSpeed::Timer:

Public Member Functions
virtual HallSwitch::Error_t	init ()=0
	Initializes the timer.
virtual HallSwitch::Error_t	deinit ()=0
	Deinitializes the timer.
virtual HallSwitch::Error_t	start ()=0
	Starts the timer.
virtual HallSwitch::Error_t	elapsed (uint32_t &elapsed)=0
	Elapsed time since the timer was started.
virtual HallSwitch::Error_t	stop ()=0
	Stops the timer.
virtual HallSwitch::Error_t	delay (uint32_t timeout)=0
	Introduces a delay during the specified time

Member Function Documentation

init()

virtual HallSwitch::Error_t HallSpeed::Timer::init ( )

pure virtual

Initializes the timer.

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

deinit()

virtual HallSwitch::Error_t HallSpeed::Timer::deinit ( )

pure virtual

Deinitializes the timer.

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

start()

virtual HallSwitch::Error_t HallSpeed::Timer::start ( )

pure virtual

Starts the timer.

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

elapsed()

virtual HallSwitch::Error_t HallSpeed::Timer::elapsed ( uint32_t &  elapsed )

pure virtual

Elapsed time since the timer was started.

Parameters

[out]

elapsed

Time in milliseconds

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

stop()

virtual HallSwitch::Error_t HallSpeed::Timer::stop ( )

pure virtual

Stops the timer.

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

delay()

virtual HallSwitch::Error_t HallSpeed::Timer::delay ( uint32_t  timeout )

pure virtual

Introduces a delay during the specified time

Parameters

[in]

timeout

Delay time in milliseconds

Returns

Timer error code

Return values

OK	if success
INIT_ERROR	if hardware interface error

Implemented in TimerIno.

---

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

• hall-pal-timer.hpp