Jhon Plantikow / DHT11

DHT11

CircularBuffer.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:c52df770855b 1 /* mbed Microcontroller Library
jhon309 0:c52df770855b 2 * Copyright (c) 2015 ARM Limited
jhon309 0:c52df770855b 3 *
jhon309 0:c52df770855b 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:c52df770855b 5 * you may not use this file except in compliance with the License.
jhon309 0:c52df770855b 6 * You may obtain a copy of the License at
jhon309 0:c52df770855b 7 *
jhon309 0:c52df770855b 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:c52df770855b 9 *
jhon309 0:c52df770855b 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:c52df770855b 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:c52df770855b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:c52df770855b 13 * See the License for the specific language governing permissions and
jhon309 0:c52df770855b 14 * limitations under the License.
jhon309 0:c52df770855b 15 */
jhon309 0:c52df770855b 16 #ifndef MBED_CIRCULARBUFFER_H
jhon309 0:c52df770855b 17 #define MBED_CIRCULARBUFFER_H
jhon309 0:c52df770855b 18
jhon309 0:c52df770855b 19 namespace mbed {
jhon309 0:c52df770855b 20
jhon309 0:c52df770855b 21 /** Templated Circular buffer class
jhon309 0:c52df770855b 22 */
jhon309 0:c52df770855b 23 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
jhon309 0:c52df770855b 24 class CircularBuffer {
jhon309 0:c52df770855b 25 public:
jhon309 0:c52df770855b 26 CircularBuffer() : _head(0), _tail(0), _full(false) {
jhon309 0:c52df770855b 27 }
jhon309 0:c52df770855b 28
jhon309 0:c52df770855b 29 ~CircularBuffer() {
jhon309 0:c52df770855b 30 }
jhon309 0:c52df770855b 31
jhon309 0:c52df770855b 32 /** Push the transaction to the buffer. This overwrites the buffer if it's
jhon309 0:c52df770855b 33 * full
jhon309 0:c52df770855b 34 *
jhon309 0:c52df770855b 35 * @param data Data to be pushed to the buffer
jhon309 0:c52df770855b 36 */
jhon309 0:c52df770855b 37 void push(const T& data) {
jhon309 0:c52df770855b 38 if (full()) {
jhon309 0:c52df770855b 39 _tail++;
jhon309 0:c52df770855b 40 _tail %= BufferSize;
jhon309 0:c52df770855b 41 }
jhon309 0:c52df770855b 42 _pool[_head++] = data;
jhon309 0:c52df770855b 43 _head %= BufferSize;
jhon309 0:c52df770855b 44 if (_head == _tail) {
jhon309 0:c52df770855b 45 _full = true;
jhon309 0:c52df770855b 46 }
jhon309 0:c52df770855b 47 }
jhon309 0:c52df770855b 48
jhon309 0:c52df770855b 49 /** Pop the transaction from the buffer
jhon309 0:c52df770855b 50 *
jhon309 0:c52df770855b 51 * @param data Data to be pushed to the buffer
jhon309 0:c52df770855b 52 * @return True if the buffer is not empty and data contains a transaction, false otherwise
jhon309 0:c52df770855b 53 */
jhon309 0:c52df770855b 54 bool pop(T& data) {
jhon309 0:c52df770855b 55 if (!empty()) {
jhon309 0:c52df770855b 56 data = _pool[_tail++];
jhon309 0:c52df770855b 57 _tail %= BufferSize;
jhon309 0:c52df770855b 58 _full = false;
jhon309 0:c52df770855b 59 return true;
jhon309 0:c52df770855b 60 }
jhon309 0:c52df770855b 61 return false;
jhon309 0:c52df770855b 62 }
jhon309 0:c52df770855b 63
jhon309 0:c52df770855b 64 /** Check if the buffer is empty
jhon309 0:c52df770855b 65 *
jhon309 0:c52df770855b 66 * @return True if the buffer is empty, false if not
jhon309 0:c52df770855b 67 */
jhon309 0:c52df770855b 68 bool empty() {
jhon309 0:c52df770855b 69 return (_head == _tail) && !_full;
jhon309 0:c52df770855b 70 }
jhon309 0:c52df770855b 71
jhon309 0:c52df770855b 72 /** Check if the buffer is full
jhon309 0:c52df770855b 73 *
jhon309 0:c52df770855b 74 * @return True if the buffer is full, false if not
jhon309 0:c52df770855b 75 */
jhon309 0:c52df770855b 76 bool full() {
jhon309 0:c52df770855b 77 return _full;
jhon309 0:c52df770855b 78 }
jhon309 0:c52df770855b 79
jhon309 0:c52df770855b 80 /** Reset the buffer
jhon309 0:c52df770855b 81 *
jhon309 0:c52df770855b 82 */
jhon309 0:c52df770855b 83 void reset() {
jhon309 0:c52df770855b 84 _head = 0;
jhon309 0:c52df770855b 85 _tail = 0;
jhon309 0:c52df770855b 86 _full = false;
jhon309 0:c52df770855b 87 }
jhon309 0:c52df770855b 88
jhon309 0:c52df770855b 89 private:
jhon309 0:c52df770855b 90 T _pool[BufferSize];
jhon309 0:c52df770855b 91 volatile CounterType _head;
jhon309 0:c52df770855b 92 volatile CounterType _tail;
jhon309 0:c52df770855b 93 volatile bool _full;
jhon309 0:c52df770855b 94 };
jhon309 0:c52df770855b 95
jhon309 0:c52df770855b 96 }
jhon309 0:c52df770855b 97
jhon309 0:c52df770855b 98 #endif