Hall Switch  2.1.0
C++ library of Infineon single Hall-effect switch family for magnetic sensing applications
Public Member Functions | List of all members
HallSpeed::Timer Class Referenceabstract
Core Library » Platform Abstraction Layer Interface

#include <hall-pal-timer.hpp>

Inheritance diagram for HallSpeed::Timer:
Inheritance graph
[legend]

Public Member Functions

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

Member Function Documentation

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

Initializes the timer.

Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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

Deinitializes the timer.

Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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

Starts the timer.

Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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

Elapsed time since the timer was started.

Parameters
[out]elapsedTime in milliseconds
Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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

Stops the timer.

Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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

Introduces a delay during the specified time.

Parameters
[in]timeoutDelay time in milliseconds
Returns
Timer error code
Return values
OKif success
INIT_ERRORif hardware interface error

Implemented in TimerIno.

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