rmc.h

Go to the documentation of this file.

#pragma once
 
#include <nmealib/nmea0183.h>
 
namespace nmealib {
namespace nmea0183 {
 
class NotRMCException : public NmeaException {
public:
    explicit NotRMCException(const std::string& context, const std::string& details = "") : 
    NmeaException(context, "The sentence is not an RMC sentence", details) {}
};
 
class RMC : public Message0183 {
public:
    RMC(std::string talkerId,
        unsigned int utcFix, 
        char status, 
        double latitude,
        char latitudeDirection, 
        double longitude,
        char longitudeDirection,
        double speedOverGround, 
        double courseOverGround, 
        unsigned int date, 
        double magneticVariation,
        char magneticVariationDirection,
        char modeIndicator,
        char navigationStatus
    );
 
    RMC(const RMC&) = default;
    RMC& operator=(const RMC&) = default;
    RMC(RMC&&) noexcept = default;
    RMC& operator=(RMC&&) noexcept = default;
 
    ~RMC() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    unsigned int getUtcFix() const noexcept;
    char getStatus() const noexcept;
    double getLatitude() const noexcept;
    char getLatitudeDirection() const noexcept;
    double getLongitude() const noexcept;
    char getLongitudeDirection() const noexcept;
    double getSpeedOverGround() const noexcept;
    double getCourseOverGround() const noexcept;
    unsigned int getDate() const noexcept;
    double getMagneticVariation() const noexcept;
    char getMagneticVariationDirection() const noexcept;
    char getModeIndicator() const noexcept;
    char getNavigationStatus() const noexcept;
 
    std::string getStringContent(bool verbose) const noexcept override;
 
    bool operator==(const RMC& other) const noexcept;
 
private:
    unsigned int utcFix_{};
    char status_{};
    double latitude_{};
    char latitudeDirection_{};
    double longitude_{};
    char longitudeDirection_{};
    double speedOverGround_{};
    double courseOverGround_{};
    unsigned int date_{};
    double magneticVariation_{};
    char magneticVariationDirection_{};
    char modeIndicator_{};
    char navigationStatus_{};
 
    RMC() = delete;
 
    RMC(Message0183 baseMessage, 
        unsigned int utcFix, 
        char status, 
        double latitude,
        char latitudeDirection, 
        double longitude,
        char longitudeDirection,
        double speedOverGround, 
        double courseOverGround, 
        unsigned int date, 
        double magneticVariation,
        char magneticVariationDirection,
        char modeIndicator,
        char navigationStatus
    ) noexcept;
 
    static std::unique_ptr<RMC> create(std::unique_ptr<Message0183> baseMessage);
    static std::string composeRaw(const std::string& talkerId, unsigned int utcFix, 
                            char status, 
                            double latitude,
                            char latitudeDirection, 
                            double longitude,
                            char longitudeDirection,
                            double speedOverGround, 
                            double courseOverGround, 
                            unsigned int date, 
                            double magneticVariation,
                            char magneticVariationDirection,
                            char modeIndicator,
                            char navigationStatus);
    
    friend class Nmea0183Factory;
    friend class MessageRegistry;
};
 
} // namespace nmea0183
} // namespace nmealib