ngscopeclient 0.1-dev+51fbda87c
BinaryDriver.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopehal *
4* *
5* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
38#ifndef BinaryDriver_h
39#define BinaryDriver_h
40
46{
47public:
50
51
52protected:
53
62 void PushUint16(std::vector<uint8_t>* data, uint16_t value, bool littleEndian = true)
63 {
64 data->push_back(reinterpret_cast<uint8_t *>(&value)[littleEndian ? 0 : 1]);
65 data->push_back(reinterpret_cast<uint8_t *>(&value)[littleEndian ? 1 : 0]);
66 }
67
77 uint16_t ReadUint16(const std::vector<uint8_t>& data, uint8_t index, bool littleEndian = true)
78 {
79 if(data.size() <= ((size_t)(index+1)))
80 return 0;
81 return (static_cast<uint16_t>(data[littleEndian ? index : (index+1)]) + (static_cast<uint16_t>(data[littleEndian ? (index+1) : index]) << 8));
82 }
83
92 uint8_t ReadUint8(const std::vector<uint8_t>& data, uint8_t index)
93 {
94 if(data.size() <= ((size_t)(index)))
95 return 0;
96 return data[index];
97 }
98
99 uint16_t CalculateCRC(const uint8_t *buff, size_t len);
100};
101
102#endif
Helper class for binary driver: provides methods for handling binary data.
Definition: BinaryDriver.h:46
uint16_t ReadUint16(const std::vector< uint8_t > &data, uint8_t index, bool littleEndian=true)
Bounds-checked read of a 16-bit value from a byte vector.
Definition: BinaryDriver.h:77
uint8_t ReadUint8(const std::vector< uint8_t > &data, uint8_t index)
Bounds-checked read of an 8-bit value from a byte vector.
Definition: BinaryDriver.h:92
void PushUint16(std::vector< uint8_t > *data, uint16_t value, bool littleEndian=true)
Helper function to push a uint16 to a std::vector of bytes, as two consecutive bytes (either little-e...
Definition: BinaryDriver.h:62