PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/Ticker.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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