Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
RawBytes.h
1 /*
2  * The MIT License (MIT)
3  *
4  * Copyright (c) 2016 The SKA organisation
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef SKA_CHEETAH_PSRDADA_RAWBYTES_H
25 #define SKA_CHEETAH_PSRDADA_RAWBYTES_H
26 
27 #include <cstddef>
28 
29 namespace ska {
30 namespace cheetah {
31 namespace psrdada {
32 namespace detail {
33 
45 class RawBytes
46 {
47 
48  public:
56  RawBytes(char * ptr, std::size_t total, std::size_t used=0);
57  RawBytes(RawBytes const&) = delete;
58  ~RawBytes();
59 
63  std::size_t total_bytes() const;
64 
68  std::size_t used_bytes() const;
69 
77  void used_bytes(std::size_t);
78 
82  char * ptr() const;
83 
84  private:
85  char * _ptr;
86  std::size_t _total_bytes;
87  std::size_t _used_bytes;
88 };
89 
90 } // namespace detail
91 } // namespace psrdada
92 } // namespace cheetah
93 } // namespace ska
94 
95 #endif // SKA_CHEETAH_PSRDADA_RAWBYTES_H
Class for wrapping a raw pointer to a buffer of shared memory.
Definition: RawBytes.h:45
char * ptr() const
Get a raw pointer to the start of the buffer.
Definition: RawBytes.cpp:59
std::size_t total_bytes() const
Get the total number of bytes in the buffer.
Definition: RawBytes.cpp:44
Some limits and constants for FLDO.
Definition: Brdz.h:35
std::size_t used_bytes() const
Get the number of currently used bytes in the buffer.
Definition: RawBytes.cpp:49
RawBytes(char *ptr, std::size_t total, std::size_t used=0)
Create a new RawBytes instance.
Definition: RawBytes.cpp:33