FMTBaseVertexProperties.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 FMTbasevertexproperties_Hm_included
#define FMTbasevertexproperties_Hm_included
 
 
 
#include <boost/serialization/serialization.hpp>
#include <boost/functional/hash.hpp>
#include <boost/serialization/export.hpp>
#include <boost/serialization/nvp.hpp>
#include <memory>
#include "FMTutility.h"
 
 
namespace Core {
    class FMTActualDevelopment;
    class FMTFuturDevelopment;
    class FMTMask;
    class FMTDevelopment;
}
 
 
 
namespace Graph
{
    class FMTEXPORT FMTBaseVertexProperties
    {
    public:
        // DocString: FMTBaseVertexProperties::~FMTBaseVertexProperties
        virtual ~FMTBaseVertexProperties() = default;
        // DocString: FMTBaseVertexProperties::FMTBaseVertexProperties()
        FMTBaseVertexProperties() = default;
        // DocString: FMTBaseVertexProperties::FMTBaseVertexProperties(const FMTBaseVertexProperties&)
        FMTBaseVertexProperties(const FMTBaseVertexProperties& rhs);
        // DocString: FMTBaseVertexProperties::operator=
        FMTBaseVertexProperties& operator = (const FMTBaseVertexProperties& rhs);
        // DocString: FMTBaseVertexProperties::FMTBaseVertexProperties(const Core::FMTFuturDevelopment&)
        FMTBaseVertexProperties(const Core::FMTFuturDevelopment& p_development);
        // DocString: FMTBaseVertexProperties::FMTBaseVertexProperties(const Core::FMTActualDevelopment&)
        FMTBaseVertexProperties(const Core::FMTActualDevelopment& p_development);
        //FMTBaseVertexProperties(const Core::FMTDevelopment& p_development);
        // DocString: FMTBaseVertexProperties::setDevlopementMask
        void setDevlopementMask(const Core::FMTMask& p_newMask);
        // DocString: FMTBaseVertexProperties::getBaseRhs
        double getBaseRhs() const;
        // DocString: FMTBaseVertexProperties::getConstraintId
        virtual int getConstraintId() const;
        // DocString: FMTBaseVertexProperties::get
        const Core::FMTDevelopment& get() const;
        // DocString: FMTBaseVertexProperties::hash
        size_t hash() const;
        // DocString: FMTBaseVertexProperties::operator<
        bool operator < (const FMTBaseVertexProperties& rhs) const;
        // DocString: FMTBaseVertexProperties::operator==
        bool operator == (const FMTBaseVertexProperties& rhs) const;
        // DocString: FMTBaseVertexProperties::operator!=
        bool operator != (const FMTBaseVertexProperties& rhs) const;
    private:
        // DocString: FMTBaseVertexProperties::serialize
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, unsigned int version)
            {
            double area = getBaseRhs();
            ar& BOOST_SERIALIZATION_NVP(*m_development);
            ar& BOOST_SERIALIZATION_NVP(area);
            if (Archive::is_saving::value)
                {
                _save(area);
                }
            }
        // DocString: FMTBaseVertexProperties::m_development
        std::unique_ptr<Core::FMTDevelopment> m_development;
        // DocString: FMTBaseVertexProperties::_save
        void _save(double p_area);
    };
}
 
 
 BOOST_CLASS_EXPORT_KEY(Graph::FMTBaseVertexProperties)
 
 
 namespace boost {
 
    template <>
    struct hash<Graph::FMTBaseVertexProperties>
    {
        std::size_t operator()(const Graph::FMTBaseVertexProperties& vertex_properties) const
        {
            return vertex_properties.hash();
        }
    };
 
 
}
 
 
#endif