Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: Freedman_v2 Nucleo_i2c_OLED_BME280_copy
Fork of mbed-src by
api/Timer.h
- Committer:
 - mbed_official
 - Date:
 - 2015-04-28
 - Revision:
 - 525:c320967f86b9
 - Parent:
 - 13:0645d8841f51
 - Child:
 - 547:88c982c8f758
 
File content as of revision 525:c320967f86b9:
/* mbed Microcontroller Library
 * Copyright (c) 2006-2013 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef MBED_TIMER_H
#define MBED_TIMER_H
#include "platform.h"
#include "ticker_api.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();
    Timer(const ticker_data_t *const data);
    /** 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
    const ticker_data_t *const _ticker_data;
};
} // namespace mbed
#endif
            
    