Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/Timer.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ebrus 0:6bc4ac881c8e 1 /* mbed Microcontroller Library
ebrus 0:6bc4ac881c8e 2 * Copyright (c) 2006-2013 ARM Limited
ebrus 0:6bc4ac881c8e 3 *
ebrus 0:6bc4ac881c8e 4 * Licensed under the Apache License, Version 2.0 (the "License");
ebrus 0:6bc4ac881c8e 5 * you may not use this file except in compliance with the License.
ebrus 0:6bc4ac881c8e 6 * You may obtain a copy of the License at
ebrus 0:6bc4ac881c8e 7 *
ebrus 0:6bc4ac881c8e 8 * http://www.apache.org/licenses/LICENSE-2.0
ebrus 0:6bc4ac881c8e 9 *
ebrus 0:6bc4ac881c8e 10 * Unless required by applicable law or agreed to in writing, software
ebrus 0:6bc4ac881c8e 11 * distributed under the License is distributed on an "AS IS" BASIS,
ebrus 0:6bc4ac881c8e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ebrus 0:6bc4ac881c8e 13 * See the License for the specific language governing permissions and
ebrus 0:6bc4ac881c8e 14 * limitations under the License.
ebrus 0:6bc4ac881c8e 15 */
ebrus 0:6bc4ac881c8e 16 #ifndef MBED_TIMER_H
ebrus 0:6bc4ac881c8e 17 #define MBED_TIMER_H
ebrus 0:6bc4ac881c8e 18
ebrus 0:6bc4ac881c8e 19 #include "platform.h"
ebrus 0:6bc4ac881c8e 20
ebrus 0:6bc4ac881c8e 21 namespace mbed {
ebrus 0:6bc4ac881c8e 22
ebrus 0:6bc4ac881c8e 23 /** A general purpose timer
ebrus 0:6bc4ac881c8e 24 *
ebrus 0:6bc4ac881c8e 25 * Example:
ebrus 0:6bc4ac881c8e 26 * @code
ebrus 0:6bc4ac881c8e 27 * // Count the time to toggle a LED
ebrus 0:6bc4ac881c8e 28 *
ebrus 0:6bc4ac881c8e 29 * #include "mbed.h"
ebrus 0:6bc4ac881c8e 30 *
ebrus 0:6bc4ac881c8e 31 * Timer timer;
ebrus 0:6bc4ac881c8e 32 * DigitalOut led(LED1);
ebrus 0:6bc4ac881c8e 33 * int begin, end;
ebrus 0:6bc4ac881c8e 34 *
ebrus 0:6bc4ac881c8e 35 * int main() {
ebrus 0:6bc4ac881c8e 36 * timer.start();
ebrus 0:6bc4ac881c8e 37 * begin = timer.read_us();
ebrus 0:6bc4ac881c8e 38 * led = !led;
ebrus 0:6bc4ac881c8e 39 * end = timer.read_us();
ebrus 0:6bc4ac881c8e 40 * printf("Toggle the led takes %d us", end - begin);
ebrus 0:6bc4ac881c8e 41 * }
ebrus 0:6bc4ac881c8e 42 * @endcode
ebrus 0:6bc4ac881c8e 43 */
ebrus 0:6bc4ac881c8e 44 class Timer {
ebrus 0:6bc4ac881c8e 45
ebrus 0:6bc4ac881c8e 46 public:
ebrus 0:6bc4ac881c8e 47 Timer();
ebrus 0:6bc4ac881c8e 48
ebrus 0:6bc4ac881c8e 49 /** Start the timer
ebrus 0:6bc4ac881c8e 50 */
ebrus 0:6bc4ac881c8e 51 void start();
ebrus 0:6bc4ac881c8e 52
ebrus 0:6bc4ac881c8e 53 /** Stop the timer
ebrus 0:6bc4ac881c8e 54 */
ebrus 0:6bc4ac881c8e 55 void stop();
ebrus 0:6bc4ac881c8e 56
ebrus 0:6bc4ac881c8e 57 /** Reset the timer to 0.
ebrus 0:6bc4ac881c8e 58 *
ebrus 0:6bc4ac881c8e 59 * If it was already counting, it will continue
ebrus 0:6bc4ac881c8e 60 */
ebrus 0:6bc4ac881c8e 61 void reset();
ebrus 0:6bc4ac881c8e 62
ebrus 0:6bc4ac881c8e 63 /** Get the time passed in seconds
ebrus 0:6bc4ac881c8e 64 */
ebrus 0:6bc4ac881c8e 65 float read();
ebrus 0:6bc4ac881c8e 66
ebrus 0:6bc4ac881c8e 67 /** Get the time passed in mili-seconds
ebrus 0:6bc4ac881c8e 68 */
ebrus 0:6bc4ac881c8e 69 int read_ms();
ebrus 0:6bc4ac881c8e 70
ebrus 0:6bc4ac881c8e 71 /** Get the time passed in micro-seconds
ebrus 0:6bc4ac881c8e 72 */
ebrus 0:6bc4ac881c8e 73 int read_us();
ebrus 0:6bc4ac881c8e 74
ebrus 0:6bc4ac881c8e 75 #ifdef MBED_OPERATORS
ebrus 0:6bc4ac881c8e 76 operator float();
ebrus 0:6bc4ac881c8e 77 #endif
ebrus 0:6bc4ac881c8e 78
ebrus 0:6bc4ac881c8e 79 protected:
ebrus 0:6bc4ac881c8e 80 int slicetime();
ebrus 0:6bc4ac881c8e 81 int _running; // whether the timer is running
ebrus 0:6bc4ac881c8e 82 unsigned int _start; // the start time of the latest slice
ebrus 0:6bc4ac881c8e 83 int _time; // any accumulated time from previous slices
ebrus 0:6bc4ac881c8e 84 };
ebrus 0:6bc4ac881c8e 85
ebrus 0:6bc4ac881c8e 86 } // namespace mbed
ebrus 0:6bc4ac881c8e 87
ebrus 0:6bc4ac881c8e 88 #endif