FMTOperatingArea.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
*/
 
#ifdef FMTWITHOSI
 
#ifndef FMToperatingarea_Hm_included
#define FMToperatingarea_Hm_included
 
#include "FMTMask.h"
#include <vector>
#include <map>
#include <memory>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
 
namespace Heuristics
    {
    // DocString: FMTOperatingArea
    class FMTEXPORT FMTOperatingArea
        {
        public:
            // DocString: FMTOperatingArea::operator+=
            FMTOperatingArea& operator += (const double& value);
            // DocString: FMTOperatingArea::getNeighbors
            std::vector<Core::FMTMask> getNeighbors() const;
            // DocString: FMTOperatingArea::getArea
            double getArea() const;
            // DocString: FMTOperatingArea::getNeighborsPerimeter
            double getNeighborsPerimeter() const;
            // DocString: FMTOperatingArea::getMask
            Core::FMTMask getMask() const;
            // DocString: FMTOperatingArea::setNeighbors
            void setNeighbors(const std::vector<Core::FMTMask>& lneighbors);
            // DocString: FMTOperatingArea(const Core::FMTMask,const double)
            FMTOperatingArea(const Core::FMTMask& lmask,const double& lneighborsperimeter);
            // DocString: FMTOperatingArea::setArea
            void setArea(const double& newarea);
 
            // DocString: FMTOperatingArea()
            FMTOperatingArea()=default;
            // DocString: FMTOperatingArea(const FMTOperatingArea)
            FMTOperatingArea(const FMTOperatingArea& rhs) = default;
            // DocString: FMTOperatingArea::operator=
            FMTOperatingArea& operator = (const FMTOperatingArea& rhs)=default;
            // DocString: FMTOperatingArea::operator==
            bool operator == (const FMTOperatingArea& rhs) const;
            // DocString: FMTOperatingArea::operator!=
            bool operator != (const FMTOperatingArea& rhs) const;
            // DocString: ~FMTOperatingArea()
            virtual ~FMTOperatingArea()=default;
            // DocString: FMTOperatingArea::preSolve
            FMTOperatingArea preSolveOperatingArea(const Core::FMTMaskFilter& filter, const std::vector<Core::FMTTheme>&presolvedthemes) const;
            // DocString: FMTOperatingArea::postSolve
            FMTOperatingArea postSolveOperatingArea(const Core::FMTMaskFilter& filter, const std::vector<Core::FMTTheme>&basethemes) const;
 
        protected:
        // DocString: FMTOperatingArea::m_mask
        Core::FMTMask m_mask;
        // DocString: FMTOperatingArea::m_neighbors
        std::vector<Core::FMTMask>m_neighbors;
        // DocString: FMTOperatingArea::m_neighborsperimeter
        double m_neighborsperimeter;
        // DocString: FMTOperatingArea::m_area
        double m_area;
        private:
        // DocString: FMTOperatingArea::serialize
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
            {
            ar & boost::serialization::make_nvp("mask", m_mask);
            ar & boost::serialization::make_nvp("neighbors", m_neighbors);
            ar & boost::serialization::make_nvp("neighborsperimeter", m_neighborsperimeter);
            ar & boost::serialization::make_nvp("_area", m_area);
            }
        };
 
    // DocString: FMTOperatingAreaComparator
    class FMTEXPORT FMTOperatingAreaComparator
        {
        public:
            // DocString: FMTOperatingAreaComparator(const Core::FMTMask)
            FMTOperatingAreaComparator(const Core::FMTMask& lmask);
            // DocString: FMTOperatingAreaComparator(const FMTOperatingArea& oparea)
            FMTOperatingAreaComparator(const FMTOperatingArea& oparea);
            // DocString: FMTOperatingAreaComparator::operator()
            bool operator()(const FMTOperatingArea& oparea) const;
 
        private:
            // DocString: FMTOperatingAreaComparator::m_mask
            Core::FMTMask m_mask;
        };
 
    }
    BOOST_CLASS_EXPORT_KEY(Heuristics::FMTOperatingArea)
#endif
#endif