Vladimir Vana / mbed

pro vyuku PSS v Jecne

CircularBuffer.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) 2015 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_CIRCULARBUFFER_H
vladvana 0:23d1f73bf130 17 #define MBED_CIRCULARBUFFER_H
vladvana 0:23d1f73bf130 18
vladvana 0:23d1f73bf130 19 namespace mbed {
vladvana 0:23d1f73bf130 20
vladvana 0:23d1f73bf130 21 /** Templated Circular buffer class
vladvana 0:23d1f73bf130 22 */
vladvana 0:23d1f73bf130 23 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
vladvana 0:23d1f73bf130 24 class CircularBuffer {
vladvana 0:23d1f73bf130 25 public:
vladvana 0:23d1f73bf130 26 CircularBuffer() : _head(0), _tail(0), _full(false) {
vladvana 0:23d1f73bf130 27 }
vladvana 0:23d1f73bf130 28
vladvana 0:23d1f73bf130 29 ~CircularBuffer() {
vladvana 0:23d1f73bf130 30 }
vladvana 0:23d1f73bf130 31
vladvana 0:23d1f73bf130 32 /** Push the transaction to the buffer. This overwrites the buffer if it's
vladvana 0:23d1f73bf130 33 * full
vladvana 0:23d1f73bf130 34 *
vladvana 0:23d1f73bf130 35 * @param data Data to be pushed to the buffer
vladvana 0:23d1f73bf130 36 */
vladvana 0:23d1f73bf130 37 void push(const T& data) {
vladvana 0:23d1f73bf130 38 if (full()) {
vladvana 0:23d1f73bf130 39 _tail++;
vladvana 0:23d1f73bf130 40 _tail %= BufferSize;
vladvana 0:23d1f73bf130 41 }
vladvana 0:23d1f73bf130 42 _pool[_head++] = data;
vladvana 0:23d1f73bf130 43 _head %= BufferSize;
vladvana 0:23d1f73bf130 44 if (_head == _tail) {
vladvana 0:23d1f73bf130 45 _full = true;
vladvana 0:23d1f73bf130 46 }
vladvana 0:23d1f73bf130 47 }
vladvana 0:23d1f73bf130 48
vladvana 0:23d1f73bf130 49 /** Pop the transaction from the buffer
vladvana 0:23d1f73bf130 50 *
vladvana 0:23d1f73bf130 51 * @param data Data to be pushed to the buffer
vladvana 0:23d1f73bf130 52 * @return True if the buffer is not empty and data contains a transaction, false otherwise
vladvana 0:23d1f73bf130 53 */
vladvana 0:23d1f73bf130 54 bool pop(T& data) {
vladvana 0:23d1f73bf130 55 if (!empty()) {
vladvana 0:23d1f73bf130 56 data = _pool[_tail++];
vladvana 0:23d1f73bf130 57 _tail %= BufferSize;
vladvana 0:23d1f73bf130 58 _full = false;
vladvana 0:23d1f73bf130 59 return true;
vladvana 0:23d1f73bf130 60 }
vladvana 0:23d1f73bf130 61 return false;
vladvana 0:23d1f73bf130 62 }
vladvana 0:23d1f73bf130 63
vladvana 0:23d1f73bf130 64 /** Check if the buffer is empty
vladvana 0:23d1f73bf130 65 *
vladvana 0:23d1f73bf130 66 * @return True if the buffer is empty, false if not
vladvana 0:23d1f73bf130 67 */
vladvana 0:23d1f73bf130 68 bool empty() {
vladvana 0:23d1f73bf130 69 return (_head == _tail) && !_full;
vladvana 0:23d1f73bf130 70 }
vladvana 0:23d1f73bf130 71
vladvana 0:23d1f73bf130 72 /** Check if the buffer is full
vladvana 0:23d1f73bf130 73 *
vladvana 0:23d1f73bf130 74 * @return True if the buffer is full, false if not
vladvana 0:23d1f73bf130 75 */
vladvana 0:23d1f73bf130 76 bool full() {
vladvana 0:23d1f73bf130 77 return _full;
vladvana 0:23d1f73bf130 78 }
vladvana 0:23d1f73bf130 79
vladvana 0:23d1f73bf130 80 /** Reset the buffer
vladvana 0:23d1f73bf130 81 *
vladvana 0:23d1f73bf130 82 */
vladvana 0:23d1f73bf130 83 void reset() {
vladvana 0:23d1f73bf130 84 _head = 0;
vladvana 0:23d1f73bf130 85 _tail = 0;
vladvana 0:23d1f73bf130 86 _full = false;
vladvana 0:23d1f73bf130 87 }
vladvana 0:23d1f73bf130 88
vladvana 0:23d1f73bf130 89 private:
vladvana 0:23d1f73bf130 90 T _pool[BufferSize];
vladvana 0:23d1f73bf130 91 volatile CounterType _head;
vladvana 0:23d1f73bf130 92 volatile CounterType _tail;
vladvana 0:23d1f73bf130 93 volatile bool _full;
vladvana 0:23d1f73bf130 94 };
vladvana 0:23d1f73bf130 95
vladvana 0:23d1f73bf130 96 }
vladvana 0:23d1f73bf130 97
vladvana 0:23d1f73bf130 98 #endif