Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

CircularBuffer.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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