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