You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
3.2 KiB
87 lines
3.2 KiB
7 years ago
|
#ifndef AIRMAP_AIRCRAFTS_H_
|
||
|
|
#define AIRMAP_AIRCRAFTS_H_
|
||
|
|
|
||
|
|
#include <airmap/aircraft.h>
|
||
|
|
#include <airmap/do_not_copy_or_move.h>
|
||
|
|
#include <airmap/error.h>
|
||
|
|
#include <airmap/optional.h>
|
||
|
|
#include <airmap/outcome.h>
|
||
|
|
|
||
|
|
#include <functional>
|
||
|
|
#include <string>
|
||
|
|
#include <vector>
|
||
|
|
|
||
|
|
namespace airmap {
|
||
|
|
|
||
|
|
/// Aircrafts models access to a database of aircraft models (specifically drones)
|
||
|
|
/// and manufacturers.
|
||
|
|
class Aircrafts : DoNotCopyOrMove {
|
||
|
|
public:
|
||
|
|
/// Manufacturers groups together types to ease interaction with
|
||
|
|
/// Aircrafts::manufacturers.
|
||
|
|
struct Manufacturers {
|
||
|
|
/// Parameters bundles up input parameters.
|
||
|
|
struct Parameters {
|
||
|
|
Optional<std::string> manufacturer_name; ///< Search for the specific manufacturer with this name.
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Result models the outcome of calling Flights::manufacturers.
|
||
|
|
using Result = Outcome<std::vector<Aircraft::Manufacturer>, Error>;
|
||
|
|
/// Callback describes the function signature of the callback that is
|
||
|
|
/// invoked when a call to Flights::manufacturers finishes.
|
||
|
|
using Callback = std::function<void(const Result&)>;
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Models groups together types to ease interaction with
|
||
|
|
/// Aircrafts::models.
|
||
|
|
struct Models {
|
||
|
|
/// Parameters bundles up input parameters.
|
||
|
|
struct Parameters {
|
||
|
|
Optional<Aircraft::Manufacturer> manufacturer; ///< Only list models by this manufacturer.
|
||
|
|
Optional<std::string> model_name; ///< Search for the specific model with this name.
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Result models the outcome of calling Flights::models.
|
||
|
|
using Result = Outcome<std::vector<Aircraft>, Error>;
|
||
|
|
/// Callback describes the function signature of the callback that is
|
||
|
|
/// invoked when a call to Flights::models finishes.
|
||
|
|
using Callback = std::function<void(const Result&)>;
|
||
|
|
};
|
||
|
|
|
||
|
|
/// ModelForId groups together types to ease interaction with
|
||
|
|
/// Aircrafts::model_for_id.
|
||
|
|
struct ModelForId {
|
||
|
|
/// Parameters bundles up input parameters.
|
||
|
|
struct Parameters {
|
||
|
|
std::string id; ///< Search for the model with this id.
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Result models the outcome of calling Flights::model_for_id.
|
||
|
|
using Result = Outcome<Aircraft, Error>;
|
||
|
|
/// Callback describes the function signature of the callback that is
|
||
|
|
/// invoked when a call to Flights::model_for_id finishes.
|
||
|
|
using Callback = std::function<void(const Result&)>;
|
||
|
|
};
|
||
|
|
|
||
|
|
/// manufacturers queries the AirMap services for known aircraft
|
||
|
|
/// manufacturers, reporting results to 'cb'.
|
||
|
|
virtual void manufacturers(const Manufacturers::Parameters& parameters, const Manufacturers::Callback& cb) = 0;
|
||
|
|
|
||
|
|
/// models queries the AirMap services for detailed information about
|
||
|
|
/// known Aircraft models and reports back results to 'cb'.
|
||
|
|
virtual void models(const Models::Parameters& parameters, const Models::Callback& cb) = 0;
|
||
|
|
|
||
|
|
/// models queries the AirMap services for detailed information about
|
||
|
|
/// an Aircraft model identified by 'ModelForId::Parameters::id' and reports back results to 'cb'.
|
||
|
|
virtual void model_for_id(const ModelForId::Parameters& parameters, const ModelForId::Callback& cb) = 0;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
/// @cond
|
||
|
|
Aircrafts() = default;
|
||
|
|
/// @endcond
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace airmap
|
||
|
|
|
||
|
|
#endif // AIRMAP_AIRCRAFTS_H_
|