apb.h

Go to the documentation of this file.

#pragma once
 
#include <nmealib/nmea0183.h>
 
namespace nmealib {
namespace nmea0183 {
 
class NotAPBException : public NmeaException {
public:
    explicit NotAPBException(const std::string& context, const std::string& details = "") :
    NmeaException(context, "The sentence is not an APB sentence", details) {}
};
 
class APB : public Message0183 {
public:
    APB(std::string talkerId,
        char status1,
        char status2,
        double crossTrackErrorMagnitude,
        char directionToSteer,
        char crossTrackUnits,
        char arrivalCircleStatus,
        char perpendicularPassedAtWaypoint,
        double bearingOriginToDestination,
        char bearingOriginToDestinationType,
        std::string destinationWaypointId,
        double bearingPresentToDestination,
        char bearingPresentToDestinationType,
        double headingToSteerToDestinationWaypoint,
        char headingToSteerToDestinationWaypointType
    );
 
    APB(const APB&) = default;
    APB& operator=(const APB&) = default;
    APB(APB&&) noexcept = default;
    APB& operator=(APB&&) noexcept = default;
 
    ~APB() override = default;
 
    std::unique_ptr<nmealib::Message> clone() const override;
 
    char getStatus1() const noexcept;
    char getStatus2() const noexcept;
    double getCrossTrackErrorMagnitude() const noexcept;
    char getDirectionToSteer() const noexcept;
    char getCrossTrackUnits() const noexcept;
    char getArrivalCircleStatus() const noexcept;
    char getPerpendicularPassedAtWaypoint() const noexcept;
    double getBearingOriginToDestination() const noexcept;
    char getBearingOriginToDestinationType() const noexcept;
    std::string getDestinationWaypointId() const noexcept;
    double getBearingPresentToDestination() const noexcept;
    char getBearingPresentToDestinationType() const noexcept;
    double getHeadingToSteerToDestinationWaypoint() const noexcept;
    char getHeadingToSteerToDestinationWaypointType() const noexcept;
 
    std::string getStringContent(bool verbose) const noexcept override;
 
    bool operator==(const APB& other) const noexcept;
 
private:
    char status1_{};
    char status2_{};
    double crossTrackErrorMagnitude_{};
    char directionToSteer_{};
    char crossTrackUnits_{};
    char arrivalCircleStatus_{};
    char perpendicularPassedAtWaypoint_{};
    double bearingOriginToDestination_{};
    char bearingOriginToDestinationType_{};
    std::string destinationWaypointId_{};
    double bearingPresentToDestination_{};
    char bearingPresentToDestinationType_{};
    double headingToSteerToDestinationWaypoint_{};
    char headingToSteerToDestinationWaypointType_{};
 
    APB() = delete;
 
    APB(Message0183 baseMessage,
        char status1,
        char status2,
        double crossTrackErrorMagnitude,
        char directionToSteer,
        char crossTrackUnits,
        char arrivalCircleStatus,
        char perpendicularPassedAtWaypoint,
        double bearingOriginToDestination,
        char bearingOriginToDestinationType,
        std::string destinationWaypointId,
        double bearingPresentToDestination,
        char bearingPresentToDestinationType,
        double headingToSteerToDestinationWaypoint,
        char headingToSteerToDestinationWaypointType
    ) noexcept;
 
    static std::unique_ptr<APB> create(std::unique_ptr<Message0183> baseMessage);
    static std::string composeRaw(const std::string& talkerId,
                                  char status1,
                                  char status2,
                                  double crossTrackErrorMagnitude,
                                  char directionToSteer,
                                  char crossTrackUnits,
                                  char arrivalCircleStatus,
                                  char perpendicularPassedAtWaypoint,
                                  double bearingOriginToDestination,
                                  char bearingOriginToDestinationType,
                                  const std::string& destinationWaypointId,
                                  double bearingPresentToDestination,
                                  char bearingPresentToDestinationType,
                                  double headingToSteerToDestinationWaypoint,
                                  char headingToSteerToDestinationWaypointType);
 
    friend class Nmea0183Factory;
    friend class MessageRegistry;
};
 
} // namespace nmea0183
} // namespace nmealib