hdg.h

Go to the documentation of this file.

#pragma once
 
#include <nmealib/nmea0183.h>
 
namespace nmealib {
namespace nmea0183 {
 
class NotHDGException : public NmeaException {
public:
    explicit NotHDGException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "The sentence is not an HDG sentence", details) {}
};
 
class HDG : public Message0183 {
public:
    HDG(std::string talkerId,
        double magneticHeading,
        double magneticDeviation,
        char deviationDirection,
        double magneticVariation,
        char variationDirection);
 
    HDG(const HDG&) = default;
    HDG& operator=(const HDG&) = default;
    HDG(HDG&&) noexcept = default;
    HDG& operator=(HDG&&) noexcept = default;
 
    ~HDG() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    double getMagneticHeading() const noexcept;
    double getMagneticDeviation() const noexcept;
    char getDeviationDirection() const noexcept;
    double getMagneticVariation() const noexcept;
    char getVariationDirection() const noexcept;
 
    std::string getStringContent(bool verbose) const noexcept override;
 
    bool operator==(const HDG& other) const noexcept;
 
private:
    double magneticHeading_{};
    double magneticDeviation_{};
    char deviationDirection_{};
    double magneticVariation_{};
    char variationDirection_{};
 
    HDG() = delete;
 
    HDG(Message0183 baseMessage,
        double magneticHeading,
        double magneticDeviation,
        char deviationDirection,
        double magneticVariation,
        char variationDirection) noexcept;
 
    static std::unique_ptr<HDG> create(std::unique_ptr<Message0183> baseMessage);
    static std::string composeRaw(const std::string& talkerId,
                                  double magneticHeading,
                                  double magneticDeviation,
                                  char deviationDirection,
                                  double magneticVariation,
                                  char variationDirection);
 
    friend class Nmea0183Factory;
    friend class MessageRegistry;
};
 
} // namespace nmea0183
} // namespace nmealib