Jhon Plantikow / Dataloger

Dataloger

CircularBuffer.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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