Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

Timer.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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