Jhon Plantikow / Dataloger

Dataloger

Ticker.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:666850d06c9f 1 /* mbed Microcontroller Library
jhon309 0:666850d06c9f 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:666850d06c9f 3 *
jhon309 0:666850d06c9f 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:666850d06c9f 5 * you may not use this file except in compliance with the License.
jhon309 0:666850d06c9f 6 * You may obtain a copy of the License at
jhon309 0:666850d06c9f 7 *
jhon309 0:666850d06c9f 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:666850d06c9f 9 *
jhon309 0:666850d06c9f 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:666850d06c9f 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:666850d06c9f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:666850d06c9f 13 * See the License for the specific language governing permissions and
jhon309 0:666850d06c9f 14 * limitations under the License.
jhon309 0:666850d06c9f 15 */
jhon309 0:666850d06c9f 16 #ifndef MBED_TICKER_H
jhon309 0:666850d06c9f 17 #define MBED_TICKER_H
jhon309 0:666850d06c9f 18
jhon309 0:666850d06c9f 19 #include "TimerEvent.h"
jhon309 0:666850d06c9f 20 #include "FunctionPointer.h"
jhon309 0:666850d06c9f 21
jhon309 0:666850d06c9f 22 namespace mbed {
jhon309 0:666850d06c9f 23
jhon309 0:666850d06c9f 24 /** A Ticker is used to call a function at a recurring interval
jhon309 0:666850d06c9f 25 *
jhon309 0:666850d06c9f 26 * You can use as many seperate Ticker objects as you require.
jhon309 0:666850d06c9f 27 *
jhon309 0:666850d06c9f 28 * Example:
jhon309 0:666850d06c9f 29 * @code
jhon309 0:666850d06c9f 30 * // Toggle the blinking led after 5 seconds
jhon309 0:666850d06c9f 31 *
jhon309 0:666850d06c9f 32 * #include "mbed.h"
jhon309 0:666850d06c9f 33 *
jhon309 0:666850d06c9f 34 * Ticker timer;
jhon309 0:666850d06c9f 35 * DigitalOut led1(LED1);
jhon309 0:666850d06c9f 36 * DigitalOut led2(LED2);
jhon309 0:666850d06c9f 37 *
jhon309 0:666850d06c9f 38 * int flip = 0;
jhon309 0:666850d06c9f 39 *
jhon309 0:666850d06c9f 40 * void attime() {
jhon309 0:666850d06c9f 41 * flip = !flip;
jhon309 0:666850d06c9f 42 * }
jhon309 0:666850d06c9f 43 *
jhon309 0:666850d06c9f 44 * int main() {
jhon309 0:666850d06c9f 45 * timer.attach(&attime, 5);
jhon309 0:666850d06c9f 46 * while(1) {
jhon309 0:666850d06c9f 47 * if(flip == 0) {
jhon309 0:666850d06c9f 48 * led1 = !led1;
jhon309 0:666850d06c9f 49 * } else {
jhon309 0:666850d06c9f 50 * led2 = !led2;
jhon309 0:666850d06c9f 51 * }
jhon309 0:666850d06c9f 52 * wait(0.2);
jhon309 0:666850d06c9f 53 * }
jhon309 0:666850d06c9f 54 * }
jhon309 0:666850d06c9f 55 * @endcode
jhon309 0:666850d06c9f 56 */
jhon309 0:666850d06c9f 57 class Ticker : public TimerEvent {
jhon309 0:666850d06c9f 58
jhon309 0:666850d06c9f 59 public:
jhon309 0:666850d06c9f 60 Ticker() : TimerEvent() {
jhon309 0:666850d06c9f 61 }
jhon309 0:666850d06c9f 62
jhon309 0:666850d06c9f 63 Ticker(const ticker_data_t *data) : TimerEvent(data) {
jhon309 0:666850d06c9f 64 }
jhon309 0:666850d06c9f 65
jhon309 0:666850d06c9f 66 /** Attach a function to be called by the Ticker, specifiying the interval in seconds
jhon309 0:666850d06c9f 67 *
jhon309 0:666850d06c9f 68 * @param fptr pointer to the function to be called
jhon309 0:666850d06c9f 69 * @param t the time between calls in seconds
jhon309 0:666850d06c9f 70 */
jhon309 0:666850d06c9f 71 void attach(void (*fptr)(void), float t) {
jhon309 0:666850d06c9f 72 attach_us(fptr, t * 1000000.0f);
jhon309 0:666850d06c9f 73 }
jhon309 0:666850d06c9f 74
jhon309 0:666850d06c9f 75 /** Attach a member function to be called by the Ticker, specifiying the interval in seconds
jhon309 0:666850d06c9f 76 *
jhon309 0:666850d06c9f 77 * @param tptr pointer to the object to call the member function on
jhon309 0:666850d06c9f 78 * @param mptr pointer to the member function to be called
jhon309 0:666850d06c9f 79 * @param t the time between calls in seconds
jhon309 0:666850d06c9f 80 */
jhon309 0:666850d06c9f 81 template<typename T>
jhon309 0:666850d06c9f 82 void attach(T* tptr, void (T::*mptr)(void), float t) {
jhon309 0:666850d06c9f 83 attach_us(tptr, mptr, t * 1000000.0f);
jhon309 0:666850d06c9f 84 }
jhon309 0:666850d06c9f 85
jhon309 0:666850d06c9f 86 /** Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
jhon309 0:666850d06c9f 87 *
jhon309 0:666850d06c9f 88 * @param fptr pointer to the function to be called
jhon309 0:666850d06c9f 89 * @param t the time between calls in micro-seconds
jhon309 0:666850d06c9f 90 */
jhon309 0:666850d06c9f 91 void attach_us(void (*fptr)(void), timestamp_t t) {
jhon309 0:666850d06c9f 92 _function.attach(fptr);
jhon309 0:666850d06c9f 93 setup(t);
jhon309 0:666850d06c9f 94 }
jhon309 0:666850d06c9f 95
jhon309 0:666850d06c9f 96 /** Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
jhon309 0:666850d06c9f 97 *
jhon309 0:666850d06c9f 98 * @param tptr pointer to the object to call the member function on
jhon309 0:666850d06c9f 99 * @param mptr pointer to the member function to be called
jhon309 0:666850d06c9f 100 * @param t the time between calls in micro-seconds
jhon309 0:666850d06c9f 101 */
jhon309 0:666850d06c9f 102 template<typename T>
jhon309 0:666850d06c9f 103 void attach_us(T* tptr, void (T::*mptr)(void), timestamp_t t) {
jhon309 0:666850d06c9f 104 _function.attach(tptr, mptr);
jhon309 0:666850d06c9f 105 setup(t);
jhon309 0:666850d06c9f 106 }
jhon309 0:666850d06c9f 107
jhon309 0:666850d06c9f 108 virtual ~Ticker() {
jhon309 0:666850d06c9f 109 detach();
jhon309 0:666850d06c9f 110 }
jhon309 0:666850d06c9f 111
jhon309 0:666850d06c9f 112 /** Detach the function
jhon309 0:666850d06c9f 113 */
jhon309 0:666850d06c9f 114 void detach();
jhon309 0:666850d06c9f 115
jhon309 0:666850d06c9f 116 protected:
jhon309 0:666850d06c9f 117 void setup(timestamp_t t);
jhon309 0:666850d06c9f 118 virtual void handler();
jhon309 0:666850d06c9f 119
jhon309 0:666850d06c9f 120 protected:
jhon309 0:666850d06c9f 121 timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */
jhon309 0:666850d06c9f 122 FunctionPointer _function; /**< Callback. */
jhon309 0:666850d06c9f 123 };
jhon309 0:666850d06c9f 124
jhon309 0:666850d06c9f 125 } // namespace mbed
jhon309 0:666850d06c9f 126
jhon309 0:666850d06c9f 127 #endif