FMToperatingarea.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
*/
 
#ifdef FMTWITHOSI
 
#ifndef FMToperatingarea_H_INCLUDED
#define FMToperatingarea_H_INCLUDED
 
#include "FMTmask.hpp"
#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
        {
        // DocString: FMToperatingarea::serialize
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
            {
            ar & BOOST_SERIALIZATION_NVP(mask);
            ar & BOOST_SERIALIZATION_NVP(neighbors);
            ar & BOOST_SERIALIZATION_NVP(neihgborsperimeter);
            ar & BOOST_SERIALIZATION_NVP(_area);
            }
        protected:
        // DocString: FMToperatingarea::mask
        Core::FMTmask mask;
        // DocString: FMToperatingarea::neighbors
        std::vector<Core::FMTmask>neighbors;
        // DocString: FMToperatingarea::neihgborsperimeter
        double neihgborsperimeter;
        // DocString: FMToperatingarea::_area
        double _area;
        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::getneihgborsperimeter
            double getneihgborsperimeter() 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& lneihgborsperimeter);
            // 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;
 
        };
 
    // DocString: FMToperatingareacomparator
    class FMTEXPORT FMToperatingareacomparator
        {
            // DocString: FMToperatingareacomparator::mask
            Core::FMTmask mask;
        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;
 
        };
 
    }
    BOOST_CLASS_EXPORT_KEY(Heuristics::FMToperatingarea)
#endif
#endif