ownaircraftprovider.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMULATION_OWNAIRCRAFTPROVIDER_H
#define SWIFT_MISC_SIMULATION_OWNAIRCRAFTPROVIDER_H
 
#include <QObject>
#include <QtGlobal>
 
#include "misc/aviation/aircraftparts.h"
#include "misc/aviation/airlineicaocode.h"
#include "misc/aviation/callsign.h"
#include "misc/aviation/comsystem.h"
#include "misc/aviation/selcal.h"
#include "misc/geo/coordinategeodetic.h"
#include "misc/identifier.h"
#include "misc/pq/frequency.h"
#include "misc/pq/length.h"
#include "misc/provider.h"
#include "misc/simulation/aircraftmodel.h"
#include "misc/simulation/simulatedaircraft.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
    namespace aviation
    {
        class CAircraftIcaoCode;
        class CAircraftSituation;
    } // namespace aviation
 
    namespace simulation
    {
        class SWIFT_MISC_EXPORT IOwnAircraftProvider : public IProvider
        {
        public:
            virtual CSimulatedAircraft getOwnAircraft() const = 0;
 
            virtual aviation::CCallsign getOwnCallsign() const = 0;
 
            virtual aviation::CComSystem getOwnComSystem(aviation::CComSystem::ComUnit unit) const = 0;
 
            virtual aviation::CTransponder getOwnTransponder() const = 0;
 
            virtual geo::CCoordinateGeodetic getOwnAircraftPosition() const = 0;
 
            virtual aviation::CAircraftSituation getOwnAircraftSituation() const = 0;
 
            virtual aviation::CAircraftParts getOwnAircraftParts() const = 0;
 
            virtual swift::misc::simulation::CAircraftModel getOwnAircraftModel() const = 0;
 
            virtual swift::misc::physical_quantities::CLength
            getDistanceToOwnAircraft(const swift::misc::geo::ICoordinateGeodetic &position) const = 0;
 
            virtual bool updateOwnCallsign(const aviation::CCallsign &callsign) = 0;
 
            virtual bool updateOwnIcaoCodes(const aviation::CAircraftIcaoCode &aircraftIcaoCode,
                                            const aviation::CAirlineIcaoCode &airlineIcaoCode) = 0;
 
            virtual bool updateOwnModel(const swift::misc::simulation::CAircraftModel &model) = 0;
 
            virtual bool updateOwnSituation(const aviation::CAircraftSituation &situation) = 0;
 
            virtual bool updateOwnParts(const aviation::CAircraftParts &parts) = 0;
 
            virtual bool updateOwnCG(const physical_quantities::CLength &cg) = 0;
 
            // ------------------------------------------------------------------------
            // cockpit / aircraft related updates, which can come from multiple sources
            // and are subject of roundtrips -> originator
            // ------------------------------------------------------------------------
 
            bool updateCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                               const swift::misc::CIdentifier &originator);
 
            virtual bool updateCockpit(const aviation::CComSystem &com1, const aviation::CComSystem &com2,
                                       const aviation::CTransponder &transponder,
                                       const swift::misc::CIdentifier &originator) = 0;
 
            virtual bool updateActiveComFrequency(const swift::misc::physical_quantities::CFrequency &frequency,
                                                  aviation::CComSystem::ComUnit comUnit,
                                                  const swift::misc::CIdentifier &originator) = 0;
 
            virtual bool updateSelcal(const aviation::CSelcal &selcal, const swift::misc::CIdentifier &originator) = 0;
        };
 
        class SWIFT_MISC_EXPORT COwnAircraftAware : public IProviderAware<IOwnAircraftProvider>
        {
            virtual void anchor();
 
        public:
            void setOwnAircraftProvider(IOwnAircraftProvider *provider) { this->setProvider(provider); }
 
            CSimulatedAircraft getOwnAircraft() const;
 
            aviation::CCallsign getOwnCallsign() const;
 
            aviation::CComSystem getOwnComSystem(aviation::CComSystem::ComUnit unit) const;
 
            aviation::CTransponder getOwnTransponder() const;
 
            swift::misc::geo::CCoordinateGeodetic getOwnAircraftPosition() const;
 
            aviation::CAircraftSituation getOwnAircraftSituation() const;
 
            aviation::CAircraftParts getOwnAircraftParts() const;
 
            swift::misc::simulation::CAircraftModel getOwnAircraftModel() const;
 
            swift::misc::physical_quantities::CLength
            getDistanceToOwnAircraft(const swift::misc::geo::ICoordinateGeodetic &position) const;
 
            bool updateCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                               const swift::misc::CIdentifier &originator);
 
            bool updateCockpit(const aviation::CComSystem &com1, const aviation::CComSystem &com2,
                               const aviation::CTransponder &transponder, const swift::misc::CIdentifier &originator);
 
            bool updateActiveComFrequency(const swift::misc::physical_quantities::CFrequency &frequency,
                                          aviation::CComSystem::ComUnit comUnit,
                                          const swift::misc::CIdentifier &originator);
 
            bool updateSelcal(const aviation::CSelcal &selcal, const swift::misc::CIdentifier &originator);
 
            bool updateOwnCallsign(const aviation::CCallsign &callsign);
 
            bool updateOwnIcaoCodes(const aviation::CAircraftIcaoCode &aircraftIcaoData,
                                    const aviation::CAirlineIcaoCode &airlineIcaoCode);
 
            bool updateOwnModel(const swift::misc::simulation::CAircraftModel &model);
 
            bool updateOwnSituation(const aviation::CAircraftSituation &situation);
 
            bool updateOwnParts(const aviation::CAircraftParts &parts);
 
            bool updateOwnCG(const physical_quantities::CLength &cg);
 
        protected:
            COwnAircraftAware(IOwnAircraftProvider *ownAircraftProvider) : IProviderAware(ownAircraftProvider)
            {
                Q_ASSERT(ownAircraftProvider);
            }
        };
    } // namespace simulation
} // namespace swift::misc
 
Q_DECLARE_INTERFACE(swift::misc::simulation::IOwnAircraftProvider,
                    "org.swift-project.misc::simulation::iownaircraftprovider")
 
#endif // SWIFT_MISC_SIMULATION_OWNAIRCRAFTPROVIDER_H