FMTOperatingAreaCluster.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 FMToperatingareacluster_Hm_included
#define FMToperatingareacluster_Hm_included
 
#include "FMTOperatingAreaClusterBinary.h"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
#include <vector>
 
namespace Heuristics
{
    // DocString: FMTOperatingAreaCluster
    class FMTEXPORT FMTOperatingAreaCluster
    {
    public:
        // DocString: FMTOperatingAreaCluster::FMTOperatingAreaCluster()
        FMTOperatingAreaCluster() = default;
        // DocString: FMTOperatingAreaCluster::FMTOperatingAreaCluster(const FMTOperatingAreaClusterBinary&,const std::vector<FMTOperatingAreaClusterBinary>&)
        FMTOperatingAreaCluster(const FMTOperatingAreaClusterBinary& p_localcentroid,
                                const std::vector<FMTOperatingAreaClusterBinary>& p_neighborsbinaries);
        // DocString: FMTOperatingAreaCluster::FMTOperatingAreaCluster(const FMTOperatingAreaCluster&,const double&,const double&)
        FMTOperatingAreaCluster(const FMTOperatingAreaCluster& p_basecluster,
                                const double& p_minimalarea,
                                const double& p_maximalarea);
        // DocString: FMTOperatingAreaCluster::FMTOperatingAreaCluster(const FMTOperatingAreaCluster&)
        FMTOperatingAreaCluster(const FMTOperatingAreaCluster&) = default;
        // DocString: FMTOperatingAreaCluster::operator=
        FMTOperatingAreaCluster& operator = (const FMTOperatingAreaCluster&) = default;
        // DocString: FMTOperatingAreaCluster::~FMTOperatingAreaCluster()
        ~FMTOperatingAreaCluster() = default;
        // DocString: FMTOperatingAreaCluster::getBinary
        const FMTOperatingAreaClusterBinary& getBinary(const Core::FMTMask& mask) const;
        // DocString: FMTOperatingAreaCluster::getCentroid
        inline FMTOperatingAreaClusterBinary getCentroid() const
            {
            return m_centroid;
            }
        // DocString: FMTOperatingAreaCluster::getBinaries
        inline std::vector<FMTOperatingAreaClusterBinary> getBinaries() const
            {
            return m_binaries;
            }
        // DocString: FMTOperatingAreaCluster::getMaximalObjectiveVariable
        inline int getMaximalObjectiveVariable() const
            {
            return m_maxvar;
            }
        // DocString: FMTOperatingAreaCluster::getMinimalObjectiveVariable
        inline int getMinimalObjectiveVariable() const
            {
            return m_minvar;
            }
        // DocString: FMTOperatingAreaCluster::getMinimalArea
        double getMinimalArea() const;
        // DocString: FMTOperatingAreaCluster::getMaximalArea
        double getMaximalArea() const;
        // DocString: FMTOperatingAreaCluster::getMaximalStats
        double getMaximalStats() const;
        // DocString: FMTOperatingAreaCluster::getRealMinimalArea
        inline double getRealMinimalArea() const
            {
            return m_minimalarea;
            }
        // DocString: FMTOperatingAreaCluster::getRealMaximalArea
        inline double getRealMaximalArea() const
            {
            return m_maximalarea;
            }
        // DocString: FMTOperatingAreaCluster::getTotalPotentialArea
        double getTotalPotentialArea() const;
        // DocString: FMTOperatingAreaCluster::isValidArea
        bool isValidArea(const double& area) const;
        // DocString: FMTOperatingAreaCluster::setMaximalObjectiveVariable
        void setMaximalObjectiveVariable(const int& lmaxvar);
        // DocString: FMTOperatingAreaCluster::setMinimalObjectiveVariable
        void setMinimalObjectiveVariable(const int& lminvar);
        // DocString: FMTOperatingAreaCluster::setMinimalArea
        void setMinimalArea(const double& newminimalarea);
        // DocString: FMTOperatingAreaCluster::setMaximalArea
        void setMaximalArea(const double& newmaximalarea);
        // DocString: FMTOperatingAreaCluster::isValidAreaBounds
        bool isValidAreaBounds() const;
        // DocString: FMTOperatingAreaCluster::getFilteredCluster
        FMTOperatingAreaCluster getFilteredCluster(const Core::FMTMask& filterMask) const;
        // DocString: FMTOperatingAreaCluster::getAllMasks
        std::vector<Core::FMTMask>getAllMasks() const;
    private:
        friend class boost::serialization::access;
        // DocString: FMTOperatingAreaCluster::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & boost::serialization::make_nvp("maxvar", m_maxvar);
            ar & boost::serialization::make_nvp("minvar", m_minvar);
            ar & boost::serialization::make_nvp("minimalarea", m_minimalarea);
            ar & boost::serialization::make_nvp("maximalarea", m_maximalarea);
            ar & boost::serialization::make_nvp("binaries", m_binaries);
            ar & boost::serialization::make_nvp("centroid", m_centroid);
        }
        // DocString: FMTOperatingAreaCluster::m_maxvar
        int m_maxvar;
        // DocString: FMTOperatingAreaCluster::m_minvar
        int m_minvar;
        // DocString: FMTOperatingAreaCluster::m_minimalarea
        double m_minimalarea;
        // DocString: FMTOperatingAreaCluster::m_maximalarea
        double m_maximalarea;
        // DocString: FMTOperatingAreaCluster::m_binaries
        std::vector<FMTOperatingAreaClusterBinary>m_binaries;
        // DocString: FMTOperatingAreaCluster::m_centroid
        FMTOperatingAreaClusterBinary m_centroid;
    };
}
 
BOOST_CLASS_EXPORT_KEY(Heuristics::FMTOperatingAreaCluster)
#endif
#endif