gprmc.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 // *****************************************************************************
32 //
33 // Boost Software License - Version 1.0 - August 17th, 2003
34 //
35 // Permission is hereby granted, free of charge, to any person or organization
36 // obtaining a copy of the software and accompanying documentation covered by
37 // this license (the "Software") to use, reproduce, display, distribute,
38 // execute, and transmit the Software, and to prepare derivative works of the
39 // Software, and to permit third-parties to whom the Software is furnished to
40 // do so, all subject to the following:
41 
42 // The copyright notices in the Software and this entire statement, including
43 // the above license grant, this restriction and the following disclaimer,
44 // must be included in all copies of the Software, in whole or in part, and
45 // all derivative works of the Software, unless such copies or derivative
46 // works are solely in the form of machine-executable object code generated by
47 // a source language processor.
48 //
49 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51 // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
52 // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
53 // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
54 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
55 // DEALINGS IN THE SOFTWARE.
56 //
57 // *****************************************************************************
58 
59 // ROSaic includes
62 // Boost and ROS includes
63 #include <boost/make_shared.hpp>
64 
76 class GprmcParser : public BaseParser<GprmcMsg>
77 {
78 public:
83 
88  const std::string getMessageID() const override;
89 
95  GprmcMsg parseASCII(const NMEASentence& sentence, const std::string& frame_id,
96  bool use_gnss_time,
97  Timestamp time_obj) noexcept(false) override;
98 
105  bool wasLastGPRMCValid() const;
106 
110  static const std::string MESSAGE_ID;
111 
115  static constexpr double KNOTS_TO_MPS = 0.5144444;
116 
117 private:
123 };
GprmcParser::GprmcParser
GprmcParser()
Constructor of the class GprmcParser.
Definition: gprmc.hpp:82
Timestamp
uint64_t Timestamp
Definition: typedefs.hpp:92
GprmcParser::was_last_gprmc_valid_
bool was_last_gprmc_valid_
Declares a boolean representing whether or not the last GPRMC message was valid.
Definition: gprmc.hpp:122
GprmcParser::KNOTS_TO_MPS
static constexpr double KNOTS_TO_MPS
Definition: gprmc.hpp:115
BaseParser
Base class for parsing NMEA messages and SBF blocks.
Definition: parser_base_class.hpp:60
GprmcParser::MESSAGE_ID
static const std::string MESSAGE_ID
Declares the string MESSAGE_ID.
Definition: gprmc.hpp:110
GprmcParser::wasLastGPRMCValid
bool wasLastGPRMCValid() const
Tells us whether the last RMC message was valid/usable or not.
Definition: gprmc.cpp:168
GprmcParser::getMessageID
const std::string getMessageID() const override
Returns the ASCII message ID, here "$GPRMC".
Definition: gprmc.cpp:41
NMEASentence
Struct to split an NMEA sentence into its ID and its body, the latter tokenized into a vector of stri...
Definition: nmea_sentence.hpp:55
parser_base_class.hpp
Declares a base class for parsing NMEA messages and SBF blocks.
GprmcParser::parseASCII
GprmcMsg parseASCII(const NMEASentence &sentence, const std::string &frame_id, bool use_gnss_time, Timestamp time_obj) noexcept(false) override
Parses one RMC message.
Definition: gprmc.cpp:57
string_utilities.hpp
Declares lower-level string utility functions used when parsing messages.
GprmcParser
Derived class for parsing RMC messages.
Definition: gprmc.hpp:76
GprmcMsg
nmea_msgs::Gprmc GprmcMsg
Definition: typedefs.hpp:138


septentrio_gnss_driver
Author(s): Tibor Dome
autogenerated on Wed Nov 22 2023 04:04:27