kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

Timer.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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