/* Copyright (C) 2015
 * 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 and at http://www.swift-project.org/license.html. 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_GEOOBJECTLIST_H
#define BLACKMISC_GEOOBJECTLIST_H

#include "blackmisc/collection.h"
#include "blackmisc/sequence.h"
#include "blackmisc/coordinategeodetic.h"

namespace BlackMisc
{
    namespace Geo
    {
        //! List of objects with geo coordinates.
        template<class OBJ, class CONTAINER>
        class IGeoObjectList
        {
        public:

            /*!
             * Find 0..n objects within range of given coordinate
             * \param coordinate    other position
             * \param range         within range of other position
             * \return
             */
            CONTAINER findWithinRange(const BlackMisc::Geo::ICoordinateGeodetic &coordinate, const BlackMisc::PhysicalQuantities::CLength &range) const;

        protected:
            //! Constructor
            IGeoObjectList();

            //! Container
            virtual const CONTAINER &container() const = 0;

            //! Container
            virtual CONTAINER &container() = 0;
        };

        //! List of objects with geo coordinates.
        template<class OBJ, class CONTAINER>
        class IGeoObjectWithRelativePositionList : public IGeoObjectList<OBJ, CONTAINER>
        {
        public:
            //! Calculate distances, then sort by range
            void sortByRange(const BlackMisc::Geo::ICoordinateGeodetic &position, bool updateValues);

            //! If distance is already set, just sort
            void sortByDistanceToOwnAircraft();

            //! Calculate distances, remove if outside range
            void removeIfOutsideRange(const BlackMisc::Geo::ICoordinateGeodetic &position, const BlackMisc::PhysicalQuantities::CLength &maxDistance, bool updateValues);

            //! Calculate distances
            void calculcateDistanceAndBearingToPosition(const BlackMisc::Geo::ICoordinateGeodetic &position);

        protected:
            //! Constructor
            IGeoObjectWithRelativePositionList();

        };

    } //namespace
} // namespace

#endif //guard