parser_base_class.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 #ifndef PARSER_BASE_CLASS_HPP
32 #define PARSER_BASE_CLASS_HPP
33 
34 // ROSaic includes
35 #include "nmea_sentence.hpp"
36 #include "parse_exception.hpp"
37 #include "parsing_utilities.hpp"
38 
61 template <typename T>
63 {
64 public:
78  BaseParser() = default;
79 
85  virtual ~BaseParser() = default;
86 
98  virtual const std::string getMessageID() const = 0;
99 
110  template <typename SBFStructT>
111  T parseBinary(const SBFStructT& bin_msg) noexcept(false)
112  {
113  throw ParseException("ParseBinary not implemented.");
114  };
115 
126  virtual T parseASCII(const NMEASentence& sentence, const std::string& frame_id,
127  bool use_gnss_time, Timestamp time_obj) noexcept(false)
128  {
129  throw ParseException("ParseASCII not implemented.");
130  };
131 };
132 
133 #endif // PARSER_BASE_CLASS_HPP
Struct to split an NMEA sentence into its ID and its body, the latter tokenized into a vector of stri...
T parseBinary(const SBFStructT &bin_msg) noexcept(false)
Converts bin_msg into a ROS message pointer (e.g. nmea_msgs::GpggaPtr) and returns it...
virtual const std::string getMessageID() const =0
Returns the ASCII message name.
virtual ~BaseParser()=default
Default destructor of the class BaseParser.
uint64_t Timestamp
Definition: typedefs.hpp:88
Declares a derived class of the class "std::runtime_error" for throwing error messages when parsing N...
BaseParser()=default
Default constructor of the class BaseParser.
Class to declare error message format when parsing, derived from the public class "std::runtime_error...
Declares utility functions used when parsing messages.
virtual T parseASCII(const NMEASentence &sentence, const std::string &frame_id, bool use_gnss_time, Timestamp time_obj) noexcept(false)
Converts an NMEA sentence - both standardized and proprietary ones - into a ROS message pointer (e...
Base class for parsing NMEA messages and SBF blocks.
Defines a struct NMEASentence, into which NMEA sentences - both standardized and proprietary ones - s...


septentrio_gnss_driver
Author(s): Tibor Dome
autogenerated on Sat Mar 11 2023 03:12:55