FMTEvent.h

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_Hm_included
#define FMTEVENT_Hm_included
 
#include "FMTCoordinate.h"
#include <random>
#include <limits>
#include <iterator>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/set.hpp>
#include <array>
 
namespace Spatial
{
class FMTEventRelation;
// DocString: FMTEvent
class FMTEXPORT FMTEvent
    {
    public:
        // DocString: FMTEvent::midPosition()
        std::set<FMTCoordinate>::const_iterator midPosition() const;
        // DocString: ~FMTEvent()
        ~FMTEvent() = default;
        // DocString: FMTEvent(const FMTEvent&)
        FMTEvent(const FMTEvent& rhs) = default;
        // DocString: FMTEvent::operator=
        FMTEvent& operator=(const FMTEvent& rhs) = default;
        // DocString: FMTEvent()
        FMTEvent() = default;
        // DocString: FMTsaevent(const FMTCoordinate&,const int&,const int&)
        FMTEvent(const FMTCoordinate& p_location,
            int p_actionId,
            int p_period,
            size_t p_centroidGraphFamily);
        // DocString: FMTEvent::empty()
        bool empty() const;
        // DocString: FMTEvent::size()
        size_t size() const;
        // DocString: FMTEvent::hash()
        size_t hash() const;
        // DocString: FMTEvent::getRelation(const FMTEvent&)
        FMTEventRelation getRelation(const FMTEvent& rhs) const;
        // DocString: FMTEvent::operator==(const FMTEvent&)
        bool operator==(const FMTEvent& rhs) const;
        // DocString: FMTEvent::operator!=(const FMTEvent&)
        bool operator!=(const FMTEvent& rhs) const;
        // DocString: FMTEvent::operator<(const FMTEvent&)
        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);
        // DocString: FMTEvent::getActionId()
        const int& getActionId() const;
        // DocString: FMTEvent::getPeriod()
        const int& getPeriod() const;
        // DocString: FMTEvent::getGraphFamily()
        const size_t& getGraphFamily() const;
        // DocString: FMTEvent::getElements
        const std::set<FMTCoordinate>& getElements() const;
        // 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, int p_actionId, int p_period, size_t p_GraphFamily);
        // 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::willSplitEvent(const FMTCoordinate&)
        bool willSplitEvent(const FMTCoordinate& p_coordinate) const;
        // DocString: FMTEvent::splitEvent(const unsigned int&, std::vector<FMTsaevent>&)
        bool splitEvent(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::getOutsideBorders
        std::vector<std::pair<FMTCoordinate,FMTCoordinate>>getOutsideBordersPair() const;
        // DocString: FMTEvent::getenveloppe
        std::array<FMTCoordinate,4>getEnveloppe() const;
        // DocString: FMTEvent::getclosescoordinate
        void getClosesCoordinates(const FMTEvent& rhs,
            std::set<FMTCoordinate>::const_iterator& thiscoordinate,
            std::set<FMTCoordinate>::const_iterator& rhscoordinate) const;
    private:
        friend class boost::serialization::access;
        // DocString: FMTEvent::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& BOOST_SERIALIZATION_NVP(m_actionId);
            ar& BOOST_SERIALIZATION_NVP(m_period);
            ar& BOOST_SERIALIZATION_NVP(m_elements);
        }
        // DocString: FMTEvent::m_actionId
        int m_actionId;
        // DocString: FMTEvent::m_period
        int m_period;
        // DocString: FMTEvent::m_centroidGraphFamily
        size_t m_centroidGraphFamily;
        // DocString: FMTEvent::m_elements
        std::set<FMTCoordinate>m_elements;
    };
 
}
 
namespace boost {
 
    template <>
    struct hash<Spatial::FMTEvent>
    {
    std::size_t operator()(const Spatial::FMTEvent& event) const
         {
       return (event.hash());
        }
    };
 
}
#endif // FMTEVENT_Hm_included