Vladimir Vana / mbed

pro vyuku PSS v Jecne

Ticker.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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