nmea0183.h

Go to the documentation of this file.

#pragma once
 
#include "message.h"
#include "nmeaException.h"
 
#include <string>
 
namespace nmealib {
namespace nmea0183 {
 
class TooLongSentenceException : public NmeaException {
public:
    explicit TooLongSentenceException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "NMEA 0183 sentence exceeds maximum length of 82 characters", details) {}
};
 
class InvalidStartCharacterException : public NmeaException {
public:
    explicit InvalidStartCharacterException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "NMEA 0183 sentence must start with '$' or '!'", details) {}
};
 
class NoChecksumException : public NmeaException {
public:
    explicit NoChecksumException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "This sentence does not contain a checksum", details) {}
};
 
class NoEndlineException : public NmeaException {
public:
    explicit NoEndlineException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "NMEA 0183 sentence must end with <CR><LF>", details) {}
};
 
class NotEnoughFieldsException : public NmeaException {
public:
    explicit NotEnoughFieldsException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "NMEA 0183 sentence does not contain enough fields", details) {}
};
 
class Message0183 : public nmealib::Message {
public:
    Message0183(const Message0183&) = default;
 
    Message0183& operator=(const Message0183&) = default;
 
    Message0183(Message0183&&) noexcept = default;
 
    Message0183& operator=(Message0183&&) noexcept = default;
 
    ~Message0183() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    char getStartChar() const noexcept;
 
    std::string getTalker() const noexcept;
 
    std::string getSentenceType() const noexcept;
 
    std::string getPayload() const noexcept;
 
    std::string getChecksumStr() const;
 
    std::string getCalculatedChecksumStr() const noexcept;
 
    virtual std::string getStringContent(bool verbose) const noexcept;
 
    std::string serialize() const override;
 
    bool operator==(const Message0183& other) const noexcept;
 
    bool validate() const noexcept override;
 
    static double convertNmeaCoordinateToDecimalDegrees(const std::string& nmeaCoordinate);
 
protected:
    char startChar_;
    std::string talker_;
    std::string sentenceType_;
    std::string payload_;
    std::string checksumStr_;
    std::string calculatedChecksumStr_;
 
    static std::unique_ptr<Message0183> create(const std::string& raw, TimePoint ts = std::chrono::system_clock::now());
 
    std::string toString(bool verbose) const noexcept;
 
private:
    explicit Message0183(std::string raw,
                        TimePoint ts,
                        char startChar,
                        std::string talker,
                        std::string sentenceType,
                        std::string payload) noexcept;
    explicit Message0183(std::string raw,
                        TimePoint ts,
                        char startChar,
                        std::string talker,
                        std::string sentenceType,
                        std::string payload,
                        std::string checksumStr) noexcept;
 
    static std::string computeChecksum(const std::string& payload) noexcept;
    static bool isHexByte(const std::string& s) noexcept;
    static bool validateFormat(const std::string& context, const std::string& raw);
 
    friend class Nmea0183Factory;
};
 
} // namespace nmea0183
} // namespace nmealib