The official mbed C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

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 milliseconds.
int read_us ()
 Get the time passed in microseconds.
 operator float ()
 An operator shorthand for read()
us_timestamp_t read_high_resolution_us ()
 Get in a high resolution type the time passed in microseconds.

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 an 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()

float read (  )

Get the time passed in seconds.

Returns:
Time passed in seconds
us_timestamp_t read_high_resolution_us (  )

Get in a high resolution type the time passed in microseconds.

Returns a 64 bit integer.

int read_ms (  )

Get the time passed in milliseconds.

Returns:
Time passed in milliseconds
int read_us (  )

Get the time passed in microseconds.

Returns:
Time passed in microseconds
void reset (  )

Reset the timer to 0.

If it was already running, it will continue

void start (  )

Start the timer.

void stop (  )

Stop the timer.