Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Timer.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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