mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

Timer.h

Committer:
emilmont
Date:
2012-11-09
Revision:
8:c14af7958ef5
Parent:
2:e9a661555b58
Child:
9:663789d7729f

File content as of revision 8:c14af7958ef5:

/* mbed Microcontroller Library - Timer
 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
 */
#ifndef MBED_TIMER_H
#define MBED_TIMER_H

#include "platform.h"

namespace mbed {

/** A general purpose timer 
 *
 * Example:
 * @code
 * // 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);
 * }
 * @endcode
 */
class Timer {

public:
    Timer();
    
    /** Start the timer
     */
    void start(); 

    /** Stop the timer
     */
    void stop(); 

    /** Reset the timer to 0. 
     *
     * If it was already counting, it will continue
     */
    void reset();

    /** Get the time passed in seconds
     */
    float read();

    /** Get the time passed in mili-seconds
     */
    int read_ms();

    /** Get the time passed in micro-seconds
     */
    int read_us();

#ifdef MBED_OPERATORS 
    operator float();
#endif

protected:
    int slicetime();
    int _running;          // whether the timer is running
    unsigned int _start;   // the start time of the latest slice
    int _time;             // any accumulated time from previous slices
};

} // namespace mbed

#endif