mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

Embed: (wiki syntax)

« Back to documentation index

Timer Class Reference

A general purpose timer. More...

#include <Timer.h>

Inherits NonCopyable< Timer >.

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 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.

Private Member Functions

 MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
 NonCopyable copy constructor.
 MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
 NonCopyable copy assignment operator.

Detailed Description

A general purpose timer.

Note:
Synchronization level: Interrupt safe

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 51 of file Timer.h.


Member Function Documentation

operator float (  )

An operator shorthand for read()

Definition at line 106 of file Timer.cpp.

float read ( void   )

Get the time passed in seconds.

Returns:
Time passed in seconds

Definition at line 74 of file Timer.cpp.

us_timestamp_t read_high_resolution_us (  )

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

Definition at line 82 of file Timer.cpp.

int read_ms (  )

Get the time passed in milli-seconds.

Returns:
Time passed in milli seconds

Definition at line 78 of file Timer.cpp.

int read_us (  )

Get the time passed in micro-seconds.

Returns:
Time passed in micro seconds

Definition at line 70 of file Timer.cpp.

void reset (  )

Reset the timer to 0.

If it was already counting, it will continue

Definition at line 99 of file Timer.cpp.

void start ( void   )

Start the timer.

Definition at line 46 of file Timer.cpp.

void stop ( void   )

Stop the timer.

Definition at line 58 of file Timer.cpp.