xte.h

Go to the documentation of this file.

#pragma once
 
#include <nmealib/nmea0183.h>
 
#include <optional>
 
namespace nmealib {
namespace nmea0183 {
 
class NotXTEException : public NmeaException {
public:
    explicit NotXTEException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "The sentence is not an XTE sentence", details) {}
};
 
class XTE : public Message0183 {
public:
    XTE(std::string talkerId,
        char status1,
        char status2,
        double crossTrackError,
        char steerDirection,
        char crossTrackUnits,
        std::optional<char> faaModeIndicator = std::nullopt
    );
 
    XTE(const XTE&) = default;
    XTE& operator=(const XTE&) = default;
    XTE(XTE&&) noexcept = default;
    XTE& operator=(XTE&&) noexcept = default;
 
    ~XTE() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    char getStatus1() const noexcept;
    char getStatus2() const noexcept;
    double getCrossTrackError() const noexcept;
    char getSteerDirection() const noexcept;
    char getCrossTrackUnits() const noexcept;
    bool hasFaaModeIndicator() const noexcept;
    std::optional<char> getFaaModeIndicator() const noexcept;
 
    std::string getStringContent(bool verbose) const noexcept override;
 
    bool operator==(const XTE& other) const noexcept;
 
private:
    char status1_{};
    char status2_{};
    double crossTrackError_{};
    char steerDirection_{};
    char crossTrackUnits_{};
    std::optional<char> faaModeIndicator_{};
 
    XTE() = delete;
 
    XTE(Message0183 baseMessage,
        char status1,
        char status2,
        double crossTrackError,
        char steerDirection,
        char crossTrackUnits,
        std::optional<char> faaModeIndicator
    ) noexcept;
 
    static std::unique_ptr<XTE> create(std::unique_ptr<Message0183> baseMessage);
    static std::string composeRaw(const std::string& talkerId,
                                  char status1,
                                  char status2,
                                  double crossTrackError,
                                  char steerDirection,
                                  char crossTrackUnits,
                                  std::optional<char> faaModeIndicator);
 
    friend class Nmea0183Factory;
    friend class MessageRegistry;
};
 
} // namespace nmea0183
} // namespace nmealib