ju Lei / mbed

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

Fork of mbed by mbed official

Timer.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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