FMTevent.hpp

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTEVENT_H_INCLUDED
#define FMTEVENT_H_INCLUDED
 
#include "FMTcoordinate.hpp"
#include <random>
#include <limits>
#include <iterator>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/set.hpp>
 
namespace Spatial
{
class FMTeventrelation;
// DocString: FMTevent
class FMTEXPORT FMTevent
    {
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
    {
        //ar & BOOST_SERIALIZATION_NVP(ignition);
        //ar & BOOST_SERIALIZATION_NVP(active);
        ar & BOOST_SERIALIZATION_NVP(action_id);
        ar & BOOST_SERIALIZATION_NVP(period);
        ar & BOOST_SERIALIZATION_NVP(elements);
    }
    protected:
        // DocString: FMTevent::ignition
        //FMTcoordinate ignition;
        // DocString: FMTevent::active
        //std::vector<FMTcoordinate>active;
        // DocString: FMTsaevent::action_id
        int action_id;
        // DocString: FMTsaevent::period
        int period;
    public:
        // DocString: FMTevent::midposition()
        inline std::set<FMTcoordinate>::const_iterator midposition() const
        {
            std::set<FMTcoordinate>::const_iterator it = elements.begin();
            if (elements.size() > 1)
            {
                const size_t midlocation = (elements.size() / 2);
                std::advance(it, midlocation);
            }
            return it;
        }
        // DocString: FMTevent::elements
        std::set<FMTcoordinate>elements;
        // DocString: ~FMTevent()
        virtual ~FMTevent() = default;
        // DocString: FMTevent()
        FMTevent();
        // DocString: FMTsaevent(const FMTcoordinate&,const int&,const int&)
        FMTevent(const FMTcoordinate& location,const int& laction_id,const int& lperiod);
        // DocString: FMTevent(const FMTevent&)
        FMTevent(const FMTevent& rhs);
        // DocString: FMTevent::operator=
        FMTevent& operator=(const FMTevent& rhs);
        // DocString: FMTevent::empty()
        bool empty() const {return elements.empty();}
        // DocString: FMTevent::size()
        size_t size() const {return elements.size();}
        // DocString: FMTevent::hash()
        size_t hash() const;// {return boost::hash<Spatial::FMTcoordinate>()(ignition); }
        // DocString: FMTevent::getrelation(const FMTevent&)
        FMTeventrelation getrelation(const FMTevent& rhs) const;
        // DocString: FMTevent::operator==(const FMTevent&)
        virtual bool operator==(const FMTevent& rhs) const;
        // DocString: FMTevent::operator!=(const FMTevent&)
        bool operator!=(const FMTevent& rhs) const;
        // DocString: FMTevent::operator<(const FMTevent&)
        virtual bool operator<(const FMTevent& rhs) const;
        // DocString: FMTevent::perimeter()
        size_t perimeter() const;
        // DocString: FMTevent::height()
        size_t height() const;
        // DocString: FMTevent::width()
        size_t width() const;
        // DocString: FMTevent::averagecentroid()
        FMTcoordinate averagecentroid() const;
        // DocString: FMTevent::getstatsheader()
        static std::string getstatsheader();
        // DocString: FMTevent::getstats()
        std::string getstats() const;
        // DocString: FMTevent::erase(const FMTcoordinate&)
        virtual void erase(const FMTcoordinate& newlocation);
        // DocString: FMTevent::merge(const FMTevent& event)
        virtual void merge(const FMTevent& event);
        // DocString: FMTevent::insert(const FMTcoordinate&)
        virtual void insert(const FMTcoordinate& newlocation);
        // DocString: FMTevent::setactionid(const int&)
        void setactionid(const int& laction_id){action_id=laction_id;}
        // DocString: FMTevent::setperiod(const int&)
        void setperiod(const int& lperiod){period=lperiod;}
        // DocString: FMTevent::getactionid()
        inline const int& getactionid() const {return action_id;}
        // DocString: FMTevent::getperiod()
        inline const int& getperiod() const {return period;}
        // DocString: FMTevent::ignit(const FMTspatialaction&, const FMTcoordinate&, const int&, const int&)
        virtual std::vector<std::set<FMTcoordinate>::const_iterator> ignit(const size_t& eventmaximalsize,const std::set<FMTcoordinate>::const_iterator& ignit, const int& laction_id, const int& lperiod);
        // DocString: FMTevent::spread(const size_t& eventminimalsize,const size_t& eventmaximalsize,const size_t& neighboringsize,const std::set<FMTcoordinate>& territory, std::vector<std::set<FMTcoordinate>::const_iterator> active)
        virtual bool spread(const size_t& eventminimalsize,const size_t& eventmaximalsize,
            const size_t& neighboringsize,const std::set<FMTcoordinate>& territory, std::vector<std::set<FMTcoordinate>::const_iterator> active);
        // DocString: FMTevent::distance(const FMTevent&)
        double distance(const FMTevent& rhs) const;
        // DocString: FMTevent::within(unsigned int, const FMTevent&)
        template<typename T>
        bool within(const T& dist, const FMTevent& rhs) const;
        // DocString: FMTevent::withinc(unsigned int, const FMTcoordinate&)
        template<typename T>
        bool within(const T& dist, const FMTcoordinate& location) const;
        // DocString: FMTevent::contain(const FMTcoordinate&)
        bool contain(const FMTcoordinate& coord)const;
        // DocString: FMTevent::potentialysplittedevent(const FMTcoordinate&)
        bool potentialysplitevent(const FMTcoordinate& coord) const;
        // DocString: FMTevent::splitevent(const unsigned int&, std::vector<FMTsaevent>&)
        bool splitevent(const unsigned int& ldistance, std::vector<FMTevent>& splittedevents) const;
        // DocString: FMTevent::getterritory
        std::set<FMTcoordinate>getterritory(const size_t& distance) const;
        // DocString: FMTevent::getborders
        std::vector<std::set<FMTcoordinate>::const_iterator>getborders() const;
        // DocString: FMTevent::getenveloppe
        std::vector<FMTcoordinate>getenveloppe() const;
        // DocString: FMTevent::getclosescoordinate
        void getclosescoordinates(const FMTevent& rhs,
            std::set<FMTcoordinate>::const_iterator& thiscoordinate,
            std::set<FMTcoordinate>::const_iterator& rhscoordinate) const;
    };
 
}
 
namespace boost {
 
    template <>
    struct hash<Spatial::FMTevent>
    {
    std::size_t operator()(const Spatial::FMTevent& event) const
         {
 
      return (event.hash());
        }
    };
 
}
#endif // FMTEVENT_H_INCLUDED