PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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