Mark Turner / MarksMbed

This is a repository for all my programs or modified programs.

Timer.h@0:72480818e4a9, 2016-09-11 (annotated)

Committer:
mturner5
Date:
Sun Sep 11 23:48:09 2016 +0000
Revision:
0:72480818e4a9
Made delays for the LEDS and button presses

Who changed what in which revision?

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