Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

Timer.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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