circular_buffer.hpp
Go to the documentation of this file.
1 // *****************************************************************************
2 //
3 // © Copyright 2020, Septentrio NV/SA.
4 // All rights reserved.
5 //
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are met:
8 // 1. Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // 2. Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // 3. Neither the name of the copyright holder nor the names of its
14 // contributors may be used to endorse or promote products derived
15 // from this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 // POSSIBILITY OF SUCH DAMAGE.
28 //
29 // *****************************************************************************
30 
31 // ROS includes
33 
34 // C++ library includes
35 #include <algorithm>
36 #include <cstdint>
37 
38 #ifndef CIRCULAR_BUFFER_HPP
39 #define CIRCULAR_BUFFER_HPP
40 
53 {
54 public:
56  explicit CircularBuffer(ROSaicNodeBase* node, std::size_t capacity);
60  std::size_t size() const { return size_; }
62  std::size_t capacity() const { return capacity_; }
64  std::size_t write(const uint8_t* data, std::size_t bytes);
66  std::size_t read(uint8_t* data, std::size_t bytes);
67 
68 private:
72  std::size_t head_;
74  std::size_t tail_;
76  std::size_t size_;
78  std::size_t capacity_;
81  uint8_t* data_;
82 };
83 
84 #endif // for CIRCULAR_BUFFER_HPP
std::size_t read(uint8_t *data, std::size_t bytes)
Returns number of bytes read.
ROSaicNodeBase * node_
Pointer to the node.
std::size_t capacity() const
Returns capacity_.
std::size_t write(const uint8_t *data, std::size_t bytes)
Returns number of bytes written.
std::size_t size_
Number of bytes that have been written but not yet read.
CircularBuffer(ROSaicNodeBase *node, std::size_t capacity)
Constructor of CircularBuffer.
Class for creating, writing to and reading from a circular buffer.
~CircularBuffer()
Destructor of CircularBuffer.
std::size_t capacity_
Capacity of the circular buffer.
std::size_t head_
Specifies where we start writing.
std::size_t tail_
Specifies where we start reading.
std::size_t size() const
Returns size_.
This class is the base class for abstraction.
Definition: typedefs.hpp:160


septentrio_gnss_driver
Author(s): Tibor Dome
autogenerated on Thu Jun 23 2022 02:11:38