Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

Timer.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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