src/marnav/nmea/tpc.hpp

   1 #ifndef __MARNAV__NMEA__TPC__HPP__
   2 #define __MARNAV__NMEA__TPC__HPP__
   3
   4 #include <marnav/nmea/sentence.hpp>
   5 #include <marnav/utils/optional.hpp>
   6
   7 namespace marnav
   8 {
   9 namespace nmea
  10 {
  11 MARNAV_NMEA_DECLARE_SENTENCE_PARSE_FUNC(tpc)
  12
  13 /// @brief TPC - Trawl Position Cartesian Coordinates
  14 ///
  15 /// @code
  16 ///        1 2 3 4  5  6
  17 ///        | | | |  |  |
  18 /// $--TPC,x,M,y,P,z.z,M*hh,<CR><LF>
  19 /// @endcode
  20 ///
  21 /// Field Number:
  22 /// 1. Horizontal distance from the vessel center line
  23 /// 2. Unit of horizontal distance
  24 ///    - M = Meters
  25 /// 3. Horizontal distance from the transducer to the trawl along the vessel
  26 ///    center line. The value is normally positive assuming the trawl is located
  27 ///    behind the vessel.
  28 /// 4. Unit of horizontal distance from transducer to the trawl
  29 ///    - M = Meters
  30 /// 5. Depth of the trawl below the surface
  31 /// 6. Unit of Depth
  32 ///    - M = Meters
  33 ///
  34 class tpc : public sentence
  35 {
  36         MARNAV_NMEA_SENTENCE_FRIENDS(tpc)
  37
  38 public:
  39         constexpr static const sentence_id ID = sentence_id::TPC;
  40         constexpr static const char * TAG = "TPC";
  41
  42         tpc();
  43         tpc(const tpc &) = default;
  44         tpc & operator=(const tpc &) = default;
  45         tpc(tpc &&) = default;
  46         tpc & operator=(tpc &&) = default;
  47
  48 protected:
  49         tpc(const std::string & talker, fields::const_iterator first, fields::const_iterator last);
  50         virtual std::vector<std::string> get_data() const override;
  51
  52 private:
  53         double distance_centerline = 0.0;
  54         unit::distance distance_centerline_unit = unit::distance::meter;
  55         double distance_transducer = 0.0;
  56         unit::distance distance_transducer_unit = unit::distance::meter;
  57         double depth = 0.0;
  58         unit::distance depth_unit = unit::distance::meter;
  59
  60 public:
  61         decltype(distance_centerline) get_distance_centerline() const
  62         {
  63                 return distance_centerline;
  64         }
  65         decltype(distance_centerline_unit) get_distance_centerline_unit() const
  66         {
  67                 return distance_centerline_unit;
  68         }
  69         decltype(distance_transducer) get_distance_transducer() const
  70         {
  71                 return distance_transducer;
  72         }
  73         decltype(distance_transducer_unit) get_distance_transducer_unit() const
  74         {
  75                 return distance_transducer_unit;
  76         }
  77         decltype(depth) get_depth() const { return depth; }
  78         decltype(depth_unit) get_depth_unit() const { return depth_unit; }
  79
  80         void set_distance_centerline(double t) noexcept
  81         {
  82                 distance_centerline = t;
  83                 distance_centerline_unit = unit::distance::meter;
  84         }
  85         void set_distance_transducer(double t) noexcept
  86         {
  87                 distance_transducer = t;
  88                 distance_centerline_unit = unit::distance::meter;
  89         }
  90         void set_depth(double t) noexcept
  91         {
  92                 depth = t;
  93                 distance_centerline_unit = unit::distance::meter;
  94         }
  95 };
  96 }
  97 }
  98
  99 #endif