Goby3  3.1.4
2024.02.22
iridium_sbd_packet.h
Go to the documentation of this file.
1 // Copyright 2009-2023:
2 // GobySoft, LLC (2013-)
3 // Massachusetts Institute of Technology (2007-2014)
4 // Community contributors (see AUTHORS file)
5 // File authors:
6 // Toby Schneider <toby@gobysoft.org>
7 //
8 //
9 // This file is part of the Goby Underwater Autonomy Project Libraries
10 // ("The Goby Libraries").
11 //
12 // The Goby Libraries are free software: you can redistribute them and/or modify
13 // them under the terms of the GNU Lesser General Public License as published by
14 // the Free Software Foundation, either version 2.1 of the License, or
15 // (at your option) any later version.
16 //
17 // The Goby Libraries are distributed in the hope that they will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU Lesser General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public License
23 // along with Goby. If not, see <http://www.gnu.org/licenses/>.
24 
25 #ifndef GOBY_ACOMMS_MODEMDRIVER_SBD_PACKET_H
26 #define GOBY_ACOMMS_MODEMDRIVER_SBD_PACKET_H
27 
28 #include <cstdint>
29 #include <stdexcept>
30 #include <string>
31 
32 namespace goby
33 {
34 namespace acomms
35 {
36 class SBDPacketException : public std::runtime_error
37 {
38  public:
39  SBDPacketException(const std::string& what) : std::runtime_error(what) {}
40 };
41 
42 void serialize_sbd_packet(std::string bytes, std::string* sbd_pkt, bool include_crc = true);
43 void parse_sbd_packet(std::string* bytes, std::string sbd_pkt, bool include_crc = true);
44 
45 constexpr int IRIDIUM_SBD_CRC_BYTE_SIZE = 4;
46 } // namespace acomms
47 } // namespace goby
48 
49 #endif
goby
The global namespace for the Goby project.
Definition: acomms_constants.h:33
goby::acomms::parse_sbd_packet
void parse_sbd_packet(std::string *bytes, std::string sbd_pkt, bool include_crc=true)
goby::acomms::SBDPacketException
Definition: iridium_sbd_packet.h:36
goby::acomms::IRIDIUM_SBD_CRC_BYTE_SIZE
constexpr int IRIDIUM_SBD_CRC_BYTE_SIZE
Definition: iridium_sbd_packet.h:45
goby::acomms::SBDPacketException::SBDPacketException
SBDPacketException(const std::string &what)
Definition: iridium_sbd_packet.h:39
goby::acomms::serialize_sbd_packet
void serialize_sbd_packet(std::string bytes, std::string *sbd_pkt, bool include_crc=true)