Juan Salazar / mbed

test

Dependents:   robotic_fish_7

Timer.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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