rmb.h

Go to the documentation of this file.

#pragma once
 
#include <nmealib/nmea0183.h>
 
#include <optional>
 
namespace nmealib {
namespace nmea0183 {
 
class NotRMBException : public NmeaException {
public:
    explicit NotRMBException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "The sentence is not an RMB sentence", details) {}
};
 
class RMB : public Message0183 {
public:
    RMB(std::string talkerId,
        char status,
        double crossTrackErrorNm,
        char directionToSteer,
        std::string originWaypointId,
        std::string destinationWaypointId,
        double destinationLatitude,
        char destinationLatitudeHemisphere,
        double destinationLongitude,
        char destinationLongitudeHemisphere,
        double rangeToDestinationNm,
        double bearingToDestinationTrue,
        double destinationClosingVelocityKnots,
        char arrivalStatus,
        std::optional<char> faaModeIndicator = std::nullopt
    );
 
    RMB(const RMB&) = default;
    RMB& operator=(const RMB&) = default;
    RMB(RMB&&) noexcept = default;
    RMB& operator=(RMB&&) noexcept = default;
 
    ~RMB() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    char getStatus() const noexcept;
    double getCrossTrackErrorNm() const noexcept;
    char getDirectionToSteer() const noexcept;
    std::string getOriginWaypointId() const noexcept;
    std::string getDestinationWaypointId() const noexcept;
    double getDestinationLatitude() const noexcept;
    char getDestinationLatitudeHemisphere() const noexcept;
    double getDestinationLongitude() const noexcept;
    char getDestinationLongitudeHemisphere() const noexcept;
    double getRangeToDestinationNm() const noexcept;
    double getBearingToDestinationTrue() const noexcept;
    double getDestinationClosingVelocityKnots() const noexcept;
    char getArrivalStatus() const noexcept;
    bool hasFaaModeIndicator() const noexcept;
    std::optional<char> getFaaModeIndicator() const noexcept;
 
    std::string getStringContent(bool verbose) const noexcept override;
 
    bool operator==(const RMB& other) const noexcept;
 
private:
    char status_{};
    double crossTrackErrorNm_{};
    char directionToSteer_{};
    std::string originWaypointId_{};
    std::string destinationWaypointId_{};
    double destinationLatitude_{};
    char destinationLatitudeHemisphere_{};
    double destinationLongitude_{};
    char destinationLongitudeHemisphere_{};
    double rangeToDestinationNm_{};
    double bearingToDestinationTrue_{};
    double destinationClosingVelocityKnots_{};
    char arrivalStatus_{};
    std::optional<char> faaModeIndicator_{};
 
    RMB() = delete;
 
    RMB(Message0183 baseMessage,
        char status,
        double crossTrackErrorNm,
        char directionToSteer,
        std::string originWaypointId,
        std::string destinationWaypointId,
        double destinationLatitude,
        char destinationLatitudeHemisphere,
        double destinationLongitude,
        char destinationLongitudeHemisphere,
        double rangeToDestinationNm,
        double bearingToDestinationTrue,
        double destinationClosingVelocityKnots,
        char arrivalStatus,
        std::optional<char> faaModeIndicator
    ) noexcept;
 
    static std::unique_ptr<RMB> create(std::unique_ptr<Message0183> baseMessage);
    static std::string composeRaw(const std::string& talkerId,
                                  char status,
                                  double crossTrackErrorNm,
                                  char directionToSteer,
                                  const std::string& originWaypointId,
                                  const std::string& destinationWaypointId,
                                  double destinationLatitude,
                                  char destinationLatitudeHemisphere,
                                  double destinationLongitude,
                                  char destinationLongitudeHemisphere,
                                  double rangeToDestinationNm,
                                  double bearingToDestinationTrue,
                                  double destinationClosingVelocityKnots,
                                  char arrivalStatus,
                                  std::optional<char> faaModeIndicator);
 
    friend class Nmea0183Factory;
    friend class MessageRegistry;
};
 
} // namespace nmea0183
} // namespace nmealib