Merge branch 'main' of github.com:ECFMP/plugin

Author: AndyTWF

README.md

@@ -21,8 +21,7 @@ and
 then create an instance of it.
 
 ```c++
-#include "ECFMP/SDKFactory.h"
-#include "ECFMP/SDK.h"
+#include "ECFMP.h"
 
 auto http = std::make_shared<MyHttpClient>();
 auto logger = std::make_shared<MyLogger>();
@@ -59,7 +58,8 @@ ecfmp.EventBus().Subscribe<ECFMP::Plugin::FlowMeasureActivatedEvent>(eventListen
 You can test your integration by making use of the mocks provided by the SDK. These mocks will allow you to simulate
 events that would be sent by the ECFMP SDK.
 
-You can find the mocks in `include/mock`.
+You can find the mocks in `include/mock`, just be sure to include the main include `ECFMP.h` as well as the mocks
+header `ecfmp-sdk-mock.h`.
 
 ## Known Limitations
 

include/ECFMP/flowmeasure/AirportFilter.h

@@ -30,5 +30,10 @@ namespace ECFMP::FlowMeasure {
          * Returns the type of airport filter
          */
         [[nodiscard]] virtual auto Type() const noexcept -> AirportFilterType = 0;
+
+        /**
+         * Returns a string representation of the filter.
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/EventFilter.h

@@ -43,5 +43,10 @@ namespace ECFMP::FlowMeasure {
          * Returns true if the event participation is "Participating in"
          */
         [[nodiscard]] virtual auto IsParticipating() const noexcept -> bool = 0;
+
+        /**
+         * Returns a description of the filter.
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/FlowMeasureFilters.h

@@ -71,5 +71,10 @@ namespace ECFMP::FlowMeasure {
         [[nodiscard]] virtual auto
         FirstRangeToDestinationFilter(const std::function<bool(const RangeToDestinationFilter&)>& callback
         ) const noexcept -> std::shared_ptr<RangeToDestinationFilter> = 0;
+
+        /**
+         * Convenience method to return string description of the filters.
+         */
+        [[nodiscard]] virtual auto FilterDescriptions() const noexcept -> std::vector<std::string> = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/LevelRangeFilter.h

@@ -41,5 +41,10 @@ namespace ECFMP::FlowMeasure {
          * Helper method to determine, given a particular altitude (e.g. 35000), does this filter apply.
          */
         [[nodiscard]] virtual auto ApplicableToAltitude(int level) const noexcept -> bool = 0;
+
+        /**
+         * Description of the filter.
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/Measure.h

@@ -73,5 +73,10 @@ namespace ECFMP::FlowMeasure {
          * Throws an IllegalFlowMeasureValueException exception otherwise.
          */
         [[nodiscard]] virtual auto SetValue() const -> const std::set<std::string>& = 0;
+
+        /**
+         * Returns a string representation of the measure.
+         */
+        [[nodiscard]] virtual auto MeasureDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/MultipleLevelFilter.h

@@ -29,5 +29,10 @@ namespace ECFMP::FlowMeasure {
          * Helper method to determine, given a particular altitude (e.g. 35000), does this filter apply.
          */
         [[nodiscard]] virtual auto ApplicableToAltitude(int level) const noexcept -> bool = 0;
+
+        /**
+         * Description of the filter
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/RangeToDestinationFilter.h

@@ -8,11 +8,16 @@ namespace ECFMP::FlowMeasure {
     class RangeToDestinationFilter : public ChecksAircraftApplicability
     {
         public:
-        virtual ~RangeToDestinationFilter() = default;
+        ~RangeToDestinationFilter() override = default;
 
         /**
          * Returns the range to destination.
          */
         [[nodiscard]] virtual auto Range() const noexcept -> int = 0;
+
+        /**
+         * Description of the filter
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/ECFMP/flowmeasure/RouteFilter.h

@@ -9,6 +9,16 @@ namespace ECFMP::FlowMeasure {
     {
         public:
         virtual ~RouteFilter() = default;
+
+        /**
+         * Returns the set of route strings that this filter pertains to.
+         * @return
+         */
         [[nodiscard]] virtual auto RouteStrings() const noexcept -> const std::set<std::string>& = 0;
+
+        /**
+         * Description of the filter.
+         */
+        [[nodiscard]] virtual auto FilterDescription() const noexcept -> std::string = 0;
     };
 }// namespace ECFMP::FlowMeasure

include/mock/AirportFilterMock.h

@@ -11,6 +11,7 @@ namespace ECFMP::Mock::FlowMeasure {
         MOCK_METHOD(ECFMP::FlowMeasure::AirportFilterType, Type, (), (const, noexcept, override));
         MOCK_METHOD(bool, ApplicableToAirport, (const std::string&), (const, noexcept, override));
         MOCK_METHOD(bool, ApplicableToAircraft, (const Euroscope::EuroscopeAircraft&), (const, noexcept, override));
+        MOCK_METHOD(std::string, FilterDescription, (), (const, noexcept, override));
     };
 
 }// namespace ECFMP::Mock::FlowMeasure