George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/CallChain.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:dd0fea342ad2 1 /* mbed Microcontroller Library
gkroussos 0:dd0fea342ad2 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:dd0fea342ad2 3 *
gkroussos 0:dd0fea342ad2 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:dd0fea342ad2 5 * you may not use this file except in compliance with the License.
gkroussos 0:dd0fea342ad2 6 * You may obtain a copy of the License at
gkroussos 0:dd0fea342ad2 7 *
gkroussos 0:dd0fea342ad2 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:dd0fea342ad2 9 *
gkroussos 0:dd0fea342ad2 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:dd0fea342ad2 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:dd0fea342ad2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:dd0fea342ad2 13 * See the License for the specific language governing permissions and
gkroussos 0:dd0fea342ad2 14 * limitations under the License.
gkroussos 0:dd0fea342ad2 15 */
gkroussos 0:dd0fea342ad2 16 #ifndef MBED_CALLCHAIN_H
gkroussos 0:dd0fea342ad2 17 #define MBED_CALLCHAIN_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "FunctionPointer.h"
gkroussos 0:dd0fea342ad2 20 #include <string.h>
gkroussos 0:dd0fea342ad2 21
gkroussos 0:dd0fea342ad2 22 namespace mbed {
gkroussos 0:dd0fea342ad2 23
gkroussos 0:dd0fea342ad2 24 /** Group one or more functions in an instance of a CallChain, then call them in
gkroussos 0:dd0fea342ad2 25 * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
gkroussos 0:dd0fea342ad2 26 * but can be used for other purposes.
gkroussos 0:dd0fea342ad2 27 *
gkroussos 0:dd0fea342ad2 28 * Example:
gkroussos 0:dd0fea342ad2 29 * @code
gkroussos 0:dd0fea342ad2 30 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 31 *
gkroussos 0:dd0fea342ad2 32 * CallChain chain;
gkroussos 0:dd0fea342ad2 33 *
gkroussos 0:dd0fea342ad2 34 * void first(void) {
gkroussos 0:dd0fea342ad2 35 * printf("'first' function.\n");
gkroussos 0:dd0fea342ad2 36 * }
gkroussos 0:dd0fea342ad2 37 *
gkroussos 0:dd0fea342ad2 38 * void second(void) {
gkroussos 0:dd0fea342ad2 39 * printf("'second' function.\n");
gkroussos 0:dd0fea342ad2 40 * }
gkroussos 0:dd0fea342ad2 41 *
gkroussos 0:dd0fea342ad2 42 * class Test {
gkroussos 0:dd0fea342ad2 43 * public:
gkroussos 0:dd0fea342ad2 44 * void f(void) {
gkroussos 0:dd0fea342ad2 45 * printf("A::f (class member).\n");
gkroussos 0:dd0fea342ad2 46 * }
gkroussos 0:dd0fea342ad2 47 * };
gkroussos 0:dd0fea342ad2 48 *
gkroussos 0:dd0fea342ad2 49 * int main() {
gkroussos 0:dd0fea342ad2 50 * Test test;
gkroussos 0:dd0fea342ad2 51 *
gkroussos 0:dd0fea342ad2 52 * chain.add(second);
gkroussos 0:dd0fea342ad2 53 * chain.add_front(first);
gkroussos 0:dd0fea342ad2 54 * chain.add(&test, &Test::f);
gkroussos 0:dd0fea342ad2 55 * chain.call();
gkroussos 0:dd0fea342ad2 56 * }
gkroussos 0:dd0fea342ad2 57 * @endcode
gkroussos 0:dd0fea342ad2 58 */
gkroussos 0:dd0fea342ad2 59
gkroussos 0:dd0fea342ad2 60 typedef FunctionPointer* pFunctionPointer_t;
gkroussos 0:dd0fea342ad2 61
gkroussos 0:dd0fea342ad2 62 class CallChain {
gkroussos 0:dd0fea342ad2 63 public:
gkroussos 0:dd0fea342ad2 64 /** Create an empty chain
gkroussos 0:dd0fea342ad2 65 *
gkroussos 0:dd0fea342ad2 66 * @param size (optional) Initial size of the chain
gkroussos 0:dd0fea342ad2 67 */
gkroussos 0:dd0fea342ad2 68 CallChain(int size = 4);
gkroussos 0:dd0fea342ad2 69 virtual ~CallChain();
gkroussos 0:dd0fea342ad2 70
gkroussos 0:dd0fea342ad2 71 /** Add a function at the end of the chain
gkroussos 0:dd0fea342ad2 72 *
gkroussos 0:dd0fea342ad2 73 * @param function A pointer to a void function
gkroussos 0:dd0fea342ad2 74 *
gkroussos 0:dd0fea342ad2 75 * @returns
gkroussos 0:dd0fea342ad2 76 * The function object created for 'function'
gkroussos 0:dd0fea342ad2 77 */
gkroussos 0:dd0fea342ad2 78 pFunctionPointer_t add(void (*function)(void));
gkroussos 0:dd0fea342ad2 79
gkroussos 0:dd0fea342ad2 80 /** Add a function at the end of the chain
gkroussos 0:dd0fea342ad2 81 *
gkroussos 0:dd0fea342ad2 82 * @param tptr pointer to the object to call the member function on
gkroussos 0:dd0fea342ad2 83 * @param mptr pointer to the member function to be called
gkroussos 0:dd0fea342ad2 84 *
gkroussos 0:dd0fea342ad2 85 * @returns
gkroussos 0:dd0fea342ad2 86 * The function object created for 'tptr' and 'mptr'
gkroussos 0:dd0fea342ad2 87 */
gkroussos 0:dd0fea342ad2 88 template<typename T>
gkroussos 0:dd0fea342ad2 89 pFunctionPointer_t add(T *tptr, void (T::*mptr)(void)) {
gkroussos 0:dd0fea342ad2 90 return common_add(new FunctionPointer(tptr, mptr));
gkroussos 0:dd0fea342ad2 91 }
gkroussos 0:dd0fea342ad2 92
gkroussos 0:dd0fea342ad2 93 /** Add a function at the beginning of the chain
gkroussos 0:dd0fea342ad2 94 *
gkroussos 0:dd0fea342ad2 95 * @param function A pointer to a void function
gkroussos 0:dd0fea342ad2 96 *
gkroussos 0:dd0fea342ad2 97 * @returns
gkroussos 0:dd0fea342ad2 98 * The function object created for 'function'
gkroussos 0:dd0fea342ad2 99 */
gkroussos 0:dd0fea342ad2 100 pFunctionPointer_t add_front(void (*function)(void));
gkroussos 0:dd0fea342ad2 101
gkroussos 0:dd0fea342ad2 102 /** Add a function at the beginning of the chain
gkroussos 0:dd0fea342ad2 103 *
gkroussos 0:dd0fea342ad2 104 * @param tptr pointer to the object to call the member function on
gkroussos 0:dd0fea342ad2 105 * @param mptr pointer to the member function to be called
gkroussos 0:dd0fea342ad2 106 *
gkroussos 0:dd0fea342ad2 107 * @returns
gkroussos 0:dd0fea342ad2 108 * The function object created for 'tptr' and 'mptr'
gkroussos 0:dd0fea342ad2 109 */
gkroussos 0:dd0fea342ad2 110 template<typename T>
gkroussos 0:dd0fea342ad2 111 pFunctionPointer_t add_front(T *tptr, void (T::*mptr)(void)) {
gkroussos 0:dd0fea342ad2 112 return common_add_front(new FunctionPointer(tptr, mptr));
gkroussos 0:dd0fea342ad2 113 }
gkroussos 0:dd0fea342ad2 114
gkroussos 0:dd0fea342ad2 115 /** Get the number of functions in the chain
gkroussos 0:dd0fea342ad2 116 */
gkroussos 0:dd0fea342ad2 117 int size() const;
gkroussos 0:dd0fea342ad2 118
gkroussos 0:dd0fea342ad2 119 /** Get a function object from the chain
gkroussos 0:dd0fea342ad2 120 *
gkroussos 0:dd0fea342ad2 121 * @param i function object index
gkroussos 0:dd0fea342ad2 122 *
gkroussos 0:dd0fea342ad2 123 * @returns
gkroussos 0:dd0fea342ad2 124 * The function object at position 'i' in the chain
gkroussos 0:dd0fea342ad2 125 */
gkroussos 0:dd0fea342ad2 126 pFunctionPointer_t get(int i) const;
gkroussos 0:dd0fea342ad2 127
gkroussos 0:dd0fea342ad2 128 /** Look for a function object in the call chain
gkroussos 0:dd0fea342ad2 129 *
gkroussos 0:dd0fea342ad2 130 * @param f the function object to search
gkroussos 0:dd0fea342ad2 131 *
gkroussos 0:dd0fea342ad2 132 * @returns
gkroussos 0:dd0fea342ad2 133 * The index of the function object if found, -1 otherwise.
gkroussos 0:dd0fea342ad2 134 */
gkroussos 0:dd0fea342ad2 135 int find(pFunctionPointer_t f) const;
gkroussos 0:dd0fea342ad2 136
gkroussos 0:dd0fea342ad2 137 /** Clear the call chain (remove all functions in the chain).
gkroussos 0:dd0fea342ad2 138 */
gkroussos 0:dd0fea342ad2 139 void clear();
gkroussos 0:dd0fea342ad2 140
gkroussos 0:dd0fea342ad2 141 /** Remove a function object from the chain
gkroussos 0:dd0fea342ad2 142 *
gkroussos 0:dd0fea342ad2 143 * @arg f the function object to remove
gkroussos 0:dd0fea342ad2 144 *
gkroussos 0:dd0fea342ad2 145 * @returns
gkroussos 0:dd0fea342ad2 146 * true if the function object was found and removed, false otherwise.
gkroussos 0:dd0fea342ad2 147 */
gkroussos 0:dd0fea342ad2 148 bool remove(pFunctionPointer_t f);
gkroussos 0:dd0fea342ad2 149
gkroussos 0:dd0fea342ad2 150 /** Call all the functions in the chain in sequence
gkroussos 0:dd0fea342ad2 151 */
gkroussos 0:dd0fea342ad2 152 void call();
gkroussos 0:dd0fea342ad2 153
gkroussos 0:dd0fea342ad2 154 #ifdef MBED_OPERATORS
gkroussos 0:dd0fea342ad2 155 void operator ()(void) {
gkroussos 0:dd0fea342ad2 156 call();
gkroussos 0:dd0fea342ad2 157 }
gkroussos 0:dd0fea342ad2 158 pFunctionPointer_t operator [](int i) const {
gkroussos 0:dd0fea342ad2 159 return get(i);
gkroussos 0:dd0fea342ad2 160 }
gkroussos 0:dd0fea342ad2 161 #endif
gkroussos 0:dd0fea342ad2 162
gkroussos 0:dd0fea342ad2 163 private:
gkroussos 0:dd0fea342ad2 164 void _check_size();
gkroussos 0:dd0fea342ad2 165 pFunctionPointer_t common_add(pFunctionPointer_t pf);
gkroussos 0:dd0fea342ad2 166 pFunctionPointer_t common_add_front(pFunctionPointer_t pf);
gkroussos 0:dd0fea342ad2 167
gkroussos 0:dd0fea342ad2 168 pFunctionPointer_t* _chain;
gkroussos 0:dd0fea342ad2 169 int _size;
gkroussos 0:dd0fea342ad2 170 int _elements;
gkroussos 0:dd0fea342ad2 171 };
gkroussos 0:dd0fea342ad2 172
gkroussos 0:dd0fea342ad2 173 } // namespace mbed
gkroussos 0:dd0fea342ad2 174
gkroussos 0:dd0fea342ad2 175 #endif
gkroussos 0:dd0fea342ad2 176