forked

Embed: (wiki syntax)

« Back to documentation index

LowPowerTimer Class Reference

LowPowerTimer Class Reference
[Drivers]

Low power timer. More...

#include <LowPowerTimer.h>

Inherits mbed::Timer, and NonCopyable< LowPowerTimer >.

Public Member Functions

void start ()
 Start the timer.
void stop ()
 Stop the timer.
void reset ()
 Reset the timer to 0.
float read ()
 Get the time passed in seconds.
int read_ms ()
 Get the time passed in milli-seconds.
int read_us ()
 Get the time passed in micro-seconds.
 operator float ()
 An operator shorthand for read()
us_timestamp_t read_high_resolution_us ()
 Get in a high resolution type the time passed in micro-seconds.

Detailed Description

Low power timer.

Note:
Synchronization level: Interrupt safe

Definition at line 35 of file LowPowerTimer.h.


Member Function Documentation

operator float (  ) [inherited]

An operator shorthand for read()

Definition at line 83 of file Timer.cpp.

float read ( void   ) [inherited]

Get the time passed in seconds.

Returns:
Time passed in seconds

Definition at line 51 of file Timer.cpp.

us_timestamp_t read_high_resolution_us (  ) [inherited]

Get in a high resolution type the time passed in micro-seconds.

Definition at line 59 of file Timer.cpp.

int read_ms (  ) [inherited]

Get the time passed in milli-seconds.

Returns:
Time passed in milli seconds

Definition at line 55 of file Timer.cpp.

int read_us (  ) [inherited]

Get the time passed in micro-seconds.

Returns:
Time passed in micro seconds

Definition at line 47 of file Timer.cpp.

void reset (  ) [inherited]

Reset the timer to 0.

If it was already counting, it will continue

Definition at line 76 of file Timer.cpp.

void start ( void   ) [inherited]

Start the timer.

Definition at line 31 of file Timer.cpp.

void stop ( void   ) [inherited]

Stop the timer.

Definition at line 40 of file Timer.cpp.