TimerIno Class Reference

#include <hall-pal-ino.hpp>

Inheritance diagram for TimerIno:

Collaboration diagram for TimerIno:

Public Member Functions
	TimerIno ()
	~TimerIno ()
HallSwitch::Error_t	init ()
	Initialiazes the timer. More...
HallSwitch::Error_t	deinit ()
	Deinitialiazes the timer. More...
HallSwitch::Error_t	start ()
	Starts the timer. More...
HallSwitch::Error_t	elapsed (uint32_t &elapsed)
	Elapsed time since the timer was started. More...
HallSwitch::Error_t	stop ()
	Stops the timer. More...
HallSwitch::Error_t	delay (uint32_t timeout)
	Introduces a delay during the specified time. More...

Constructor & Destructor Documentation

TimerIno::TimerIno

(

)

TimerIno::~TimerIno

(

)

Member Function Documentation

HallSwitch::Error_t TimerIno::init ( )

inlinevirtual

Initialiazes the timer.

Returns

Timer error code

Return values

OK	if success (always)

Implements HallSpeed::Timer.

HallSwitch::Error_t TimerIno::deinit ( )

inlinevirtual

Deinitialiazes the timer.

Returns

Timer error code

Return values

OK	if success (always)

Implements HallSpeed::Timer.

HallSwitch::Error_t TimerIno::start ( )

inlinevirtual

Starts the timer.

Returns

Timer error code

Return values

OK	if success (always)

Implements HallSpeed::Timer.

HallSwitch::Error_t TimerIno::elapsed ( uint32_t &  elapsed )

inlinevirtual

Elapsed time since the timer was started.

Parameters

[out]

elapsed

Time in milliseconds

Returns

Timer error code

Return values

OK	if success (always)

Implements HallSpeed::Timer.

HallSwitch::Error_t TimerIno::stop ( )

inlinevirtual

Stops the timer.

Returns

Timer error code

Return values

OK	if success
OK	if success (always)

Implements HallSpeed::Timer.

HallSwitch::Error_t TimerIno::delay ( uint32_t  timeout )

inlinevirtual

Introduces a delay during the specified time.

Parameters

[in]

timeout

Delay time in milliseconds

Returns

Timer error code

Return values

OK	if success
OK	if success (always)

Implements HallSpeed::Timer.

---

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

• hall-pal-ino.hpp
• hall-pal-ino.cpp