parsing_utilities.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 PARSING_UTILITIES_HPP
32 #define PARSING_UTILITIES_HPP
33 
34 // C++ library includes
35 #include <cmath> // C++ header, corresponds to <math.h> in C
36 #include <cstdint> // C++ header, corresponds to <stdint.h> in C
37 #include <ctime> // C++ header, corresponds to <time.h> in C
38 #include <string> // C++ header, corresponds to <string.h> in C
39 // Eigen Includes
40 #include <Eigen/Core>
41 #include <Eigen/LU>
42 // Boost includes
43 #include <boost/math/constants/constants.hpp>
44 // ROS includes
46 
53 namespace parsing_utilities {
54 
55  constexpr double pi_half = boost::math::constants::pi<double>() / 2.0;
56 
57  /***********************************************************************
58  * Square value
59  **********************************************************************/
60  template <class T>
61  inline T square(T val)
62  {
63  return val * val;
64  }
65 
66  /***********************************************************************
67  * Convert degrees to radians
68  **********************************************************************/
69  template <class T>
70  inline T deg2rad(T deg)
71  {
72  return deg * boost::math::constants::degree<T>();
73  }
74 
75  /***********************************************************************
76  * Convert degrees^2 to radians^2
77  **********************************************************************/
78  template <class T>
79  inline T deg2radSq(T deg)
80  {
81  return deg * boost::math::constants::degree<T>() *
82  boost::math::constants::degree<T>();
83  }
84 
85  /***********************************************************************
86  * Convert radians to degree
87  **********************************************************************/
88  template <class T>
89  inline T rad2deg(T rad)
90  {
91  return rad * boost::math::constants::radian<T>();
92  }
93 
94  /***********************************************************************
95  * Convert Euler angles to rotation matrix
96  **********************************************************************/
97  inline Eigen::Matrix3d rpyToRot(double roll, double pitch, double yaw)
98  {
99  Eigen::Matrix3d M;
100  double sa, ca, sb, cb, sc, cc;
101  sa = std::sin(roll);
102  ca = std::cos(roll);
103  sb = std::sin(pitch);
104  cb = std::cos(pitch);
105  sc = std::sin(yaw);
106  cc = std::cos(yaw);
107 
108  M << cb * cc, -ca * sc + sa * sb * cc, sc * sa + ca * sb * cc, cb * sc,
109  ca * cc + sa * sb * sc, -sa * cc + ca * sb * sc, -sb, sa * cb, ca * cb;
110  return M;
111  }
112 
117  double wrapAngle180to180(double angle);
118 
124  double parseDouble(const uint8_t* buffer);
125 
138  bool parseDouble(const std::string& string, double& value);
139 
145  float parseFloat(const uint8_t* buffer);
146 
159  bool parseFloat(const std::string& string, float& value);
160 
166  int16_t parseInt16(const uint8_t* buffer);
167 
182  bool parseInt16(const std::string& string, int16_t& value, int32_t base = 10);
183 
189  int32_t parseInt32(const uint8_t* buffer);
190 
205  bool parseInt32(const std::string& string, int32_t& value, int32_t base = 10);
206 
221  bool parseUInt8(const std::string& string, uint8_t& value, int32_t base = 10);
222 
228  uint16_t parseUInt16(const uint8_t* buffer);
229 
244  bool parseUInt16(const std::string& string, uint16_t& value, int32_t base = 10);
245 
251  uint32_t parseUInt32(const uint8_t* buffer);
252 
267  bool parseUInt32(const std::string& string, uint32_t& value, int32_t base = 10);
268 
276  double convertUTCDoubleToSeconds(double utc_double);
277 
288  std::time_t convertUTCtoUnix(double utc_double);
289 
299  double convertDMSToDegrees(double dms);
300 
308  QuaternionMsg convertEulerToQuaternion(double yaw, double pitch, double roll);
309 
318  std::string convertUserPeriodToRxCommand(uint32_t period_user);
319 
326  uint16_t getCrc(const uint8_t* buffer);
327 
334  uint16_t getId(const uint8_t* buffer);
335 
342  uint16_t getLength(const uint8_t* buffer);
343 
350  uint32_t getTow(const uint8_t* buffer);
351 
358  uint16_t getWnc(const uint8_t* buffer);
359 } // namespace parsing_utilities
360 
361 #endif // PARSING_UTILITIES_HPP
parsing_utilities::getWnc
uint16_t getWnc(const uint8_t *buffer)
Get the GPS week counter of the SBF message.
Definition: parsing_utilities.cpp:358
parsing_utilities::getId
uint16_t getId(const uint8_t *buffer)
Get the ID of the SBF message.
Definition: parsing_utilities.cpp:344
parsing_utilities::getTow
uint32_t getTow(const uint8_t *buffer)
Get the time of week in ms of the SBF message.
Definition: parsing_utilities.cpp:356
parsing_utilities::rad2deg
T rad2deg(T rad)
Definition: parsing_utilities.hpp:89
parsing_utilities::wrapAngle180to180
double wrapAngle180to180(double angle)
Wraps an angle between -180 and 180 degrees.
Definition: parsing_utilities.cpp:49
parsing_utilities::convertUTCtoUnix
std::time_t convertUTCtoUnix(double utc_double)
Converts UTC time from the without-colon-delimiter format to Unix Epoch time (a number-of-seconds-sin...
Definition: parsing_utilities.cpp:268
parsing_utilities::convertUserPeriodToRxCommand
std::string convertUserPeriodToRxCommand(uint32_t period_user)
Transforms the input polling period [milliseconds] into a std::string number that can be appended to ...
Definition: parsing_utilities.cpp:328
parsing_utilities::parseInt32
int32_t parseInt32(const uint8_t *buffer)
Converts a 4-byte-buffer into a signed 32-bit integer.
Definition: parsing_utilities.cpp:135
parsing_utilities::parseFloat
float parseFloat(const uint8_t *buffer)
Converts a 4-byte-buffer into a float.
Definition: parsing_utilities.cpp:79
parsing_utilities::getLength
uint16_t getLength(const uint8_t *buffer)
Get the length of the SBF message.
Definition: parsing_utilities.cpp:354
parsing_utilities
Definition: parsing_utilities.hpp:53
parsing_utilities::convertUTCDoubleToSeconds
double convertUTCDoubleToSeconds(double utc_double)
Converts UTC time from the without-colon-delimiter format to the number-of-seconds-since-midnight for...
Definition: parsing_utilities.cpp:229
parsing_utilities::pi_half
constexpr double pi_half
Definition: parsing_utilities.hpp:55
parsing_utilities::parseUInt32
uint32_t parseUInt32(const uint8_t *buffer)
Converts a 4-byte-buffer into an unsigned 32-bit integer.
Definition: parsing_utilities.cpp:207
parsing_utilities::parseUInt16
uint16_t parseUInt16(const uint8_t *buffer)
Converts a 2-byte-buffer into an unsigned 16-bit integer.
Definition: parsing_utilities.cpp:176
parsing_utilities::convertEulerToQuaternion
QuaternionMsg convertEulerToQuaternion(double yaw, double pitch, double roll)
Transforms Euler angles to a quaternion.
Definition: parsing_utilities.cpp:309
parsing_utilities::convertDMSToDegrees
double convertDMSToDegrees(double dms)
Converts latitude or longitude from the DMS notation (in the without-colon-delimiter format),...
Definition: parsing_utilities.cpp:244
parsing_utilities::square
T square(T val)
Definition: parsing_utilities.hpp:61
typedefs.hpp
parsing_utilities::rpyToRot
Eigen::Matrix3d rpyToRot(double roll, double pitch, double yaw)
Definition: parsing_utilities.hpp:97
parsing_utilities::deg2radSq
T deg2radSq(T deg)
Definition: parsing_utilities.hpp:79
QuaternionMsg
geometry_msgs::Quaternion QuaternionMsg
Definition: typedefs.hpp:95
parsing_utilities::getCrc
uint16_t getCrc(const uint8_t *buffer)
Get the CRC of the SBF message.
Definition: parsing_utilities.cpp:342
parsing_utilities::parseUInt8
bool parseUInt8(const std::string &string, uint8_t &value, int32_t base=10)
Interprets the contents of "string" as a unsigned integer number of type uint8_t.
Definition: parsing_utilities.cpp:157
parsing_utilities::parseInt16
int16_t parseInt16(const uint8_t *buffer)
Converts a 2-byte-buffer into a signed 16-bit integer.
Definition: parsing_utilities.cpp:103
parsing_utilities::parseDouble
double parseDouble(const uint8_t *buffer)
Converts an 8-byte-buffer into a double.
Definition: parsing_utilities.cpp:62
parsing_utilities::deg2rad
T deg2rad(T deg)
Definition: parsing_utilities.hpp:70


septentrio_gnss_driver
Author(s): Tibor Dome
autogenerated on Thu Nov 10 2022 04:02:01