mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Embed: (wiki syntax)

« Back to documentation index

Timer Class Reference

Timer Class Reference

A general purpose timer. More...

#include <Timer.h>

Inherited by 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 mili-seconds.
int read_us ()
 Get the time passed in micro-seconds.

Detailed Description

A general purpose timer.

Example:

 // Count the time to toggle a LED

 #include "mbed.h"

 Timer timer;
 DigitalOut led(LED1);
 int begin, end;

 int main() {
     timer.start();
     begin = timer.read_us();
     led = !led;
     end = timer.read_us();
     printf("Toggle the led takes %d us", end - begin);
 }

Definition at line 45 of file Timer.h.


Member Function Documentation

float read ( void   )

Get the time passed in seconds.

Definition at line 46 of file Timer.cpp.

int read_ms (  )

Get the time passed in mili-seconds.

Definition at line 50 of file Timer.cpp.

int read_us (  )

Get the time passed in micro-seconds.

Definition at line 42 of file Timer.cpp.

void reset (  )

Reset the timer to 0.

If it was already counting, it will continue

Definition at line 62 of file Timer.cpp.

void start ( void   )

Start the timer.

Definition at line 30 of file Timer.cpp.

void stop ( void   )

Stop the timer.

Definition at line 37 of file Timer.cpp.