pilotclient/src/blackmisc/simulation/simulatedaircraftlist.h

/* Copyright (C) 2013
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_SIMULATION_SIMULATEDNAIRCRAFTLIST_H
#define BLACKMISC_SIMULATION_SIMULATEDNAIRCRAFTLIST_H

#include "blackmisc/simulation/simulatedaircraft.h"
#include "blackmisc/aviation/callsignobjectlist.h"
#include "blackmisc/aviation/callsignset.h"
#include "blackmisc/geo/geoobjectlist.h"
#include "blackmisc/network/userlist.h"
#include "blackmisc/blackmiscexport.h"
#include "blackmisc/collection.h"
#include "blackmisc/sequence.h"
#include <QMetaType>

namespace BlackMisc
{
    namespace Aviation
    {
        class CAircraftParts;
        class CCallsign;
    }
    namespace Simulation
    {
        class CAircraftModel;
        class CSimulatedAircraft;
    }
    namespace Simulation
    {
        //! Value object encapsulating a list of aircraft.
        class BLACKMISC_EXPORT CSimulatedAircraftList :
            public CSequence<CSimulatedAircraft>,
            public Aviation::ICallsignObjectList<CSimulatedAircraft, CSimulatedAircraftList>,
            public Geo::IGeoObjectWithRelativePositionList<CSimulatedAircraft, CSimulatedAircraftList>,
            public Mixin::MetaType<CSimulatedAircraftList>
        {
        public:
            BLACKMISC_DECLARE_USING_MIXIN_METATYPE(CSimulatedAircraftList)
            using CSequence::CSequence;

            //! Default constructor.
            CSimulatedAircraftList();

            //! Construct from a base class object.
            CSimulatedAircraftList(const CSequence<CSimulatedAircraft> &other);

            //! All pilots (with valid data)
            Network::CUserList getPilots() const;

            //! Get all models
            CAircraftModelList getModels() const;

            //! Enabled / disabled aircraft
            Q_REQUIRED_RESULT CSimulatedAircraftList findByEnabled(bool enabled) const;

            //! Rendered / not rendered aircraft
            Q_REQUIRED_RESULT CSimulatedAircraftList findByRendered(bool rendered) const;

            //! VTOL / non VTOL aircraft
            CSimulatedAircraftList findByVtol(bool vtol) const;

            //! Callsigns of aircraft with synchronized parts
            Aviation::CCallsignSet getCallsignsWithSynchronizedParts() const;

            //! Update aircraft with data from VATSIM data file
            //! \remarks The list used ("this") needs to contain the VATSIM data file objects
            bool updateWithVatsimDataFileData(CSimulatedAircraft &aircraftToBeUpdated) const;

            //! Mark all aircraft as unrendered
            void markAllAsNotRendered();

            //! Mark given callsign as rendered
            int setRendered(const Aviation::CCallsign &callsign, bool rendered, bool onlyFirst = true);

            //! Set center of gravity
            int setCG(const Aviation::CCallsign &callsign, const PhysicalQuantities::CLength &cg, bool onlyFirst = true);

            //! Mark given callsign as enabled
            int setEnabled(const Aviation::CCallsign &callsign, bool enabled, bool onlyFirst);

            //! Mark as fast position enabled
            int setFastPositionUpdates(const Aviation::CCallsign &callsign, bool fastPositions, bool onlyFirst = true);

            //! Set model
            int setAircraftModel(const Aviation::CCallsign &callsign, const CAircraftModel &model, bool onlyFirst = true);

            //! Set aircraft parts and mark as synchronized
            int setAircraftPartsSynchronized(const Aviation::CCallsign &callsign, const Aviation::CAircraftParts &parts, bool onlyFirst = true);

            //! Set aircraft situation
            int setAircraftSituation(const Aviation::CCallsign &callsign, const Aviation::CAircraftSituation &situation, bool onlyFirst = true);

            //! Set ground elevation
            int setGroundElevationChecked(const Aviation::CCallsign &callsign, const Geo::CElevationPlane &elevation, Aviation::CAircraftSituation::GndElevationInfo info, bool onlyFirst = true);

            //! Enabled?
            bool isEnabled(const Aviation::CCallsign &callsign) const;

            //! Rendered?
            bool isRendered(const Aviation::CCallsign &callsign) const;

            //! Replace or add by callsign
            bool replaceOrAddByCallsign(const CSimulatedAircraft &aircraft);

            //! Number of enabled aircraft
            int countEnabled() const;

            //! Number of rendered aircraft
            int countRendered() const;

            //! Number of aircraft with parts
            int countAircraftPartsSynchronized() const;

            //! Same as sortByDistanceToReferencePosition, but consider callsign and rendered as secondary criteria
            void sortByDistanceToReferencePositionRenderedCallsign();
        };

        //! Aircraft per callsign
        using CSimulatedAircraftPerCallsign = QHash<Aviation::CCallsign, CSimulatedAircraft>;

    } //namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Simulation::CSimulatedAircraftList)
Q_DECLARE_METATYPE(BlackMisc::Simulation::CSimulatedAircraftPerCallsign)
Q_DECLARE_METATYPE(BlackMisc::CCollection<BlackMisc::Simulation::CSimulatedAircraft>)

#endif //guard