FMTEdgeProperties.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 FMTedgeproperties_Hm_included
#define FMTedgeproperties_Hm_included
 
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <vector>
#include <string>
#include "FMTBaseEdgeProperties.h"
 
namespace Graph
{
    // DocString: FMTEdgeProperties
    class FMTEdgeProperties : public FMTBaseEdgeProperties
    {
        friend class boost::serialization::access;
        // DocString: FMTEdgeProperties::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& boost::serialization::make_nvp("FMTbaseedgeproperties", boost::serialization::base_object<FMTBaseEdgeProperties>(*this));
            ar& BOOST_SERIALIZATION_NVP(variableID);
            ar& BOOST_SERIALIZATION_NVP(proportion);
        }
        int variableID;
        float proportion;
    public:
        // DocString: ~FMTEdgeProperties()
        ~FMTEdgeProperties() = default;
        // DocString: FMTEdgeProperties()
        FMTEdgeProperties() = default;
        // DocString: FMTEdgeProperties(const FMTEdgeProperties&)
        FMTEdgeProperties(const FMTEdgeProperties& rhs) = default;
        // DocString: FMTEdgeProperties::operator=
        FMTEdgeProperties& operator = (const FMTEdgeProperties& rhs) = default;
        // DocString: FMTEdgeProperties::getVariableID
        inline int  getVariableID() const override
        {
            return variableID;
        }
        // DocString: FMTEdgeProperties::setVariableID
        void setVariableID(const int& newvariableID);
        // DocString: FMTEdgeProperties::getProportion
        inline  double getProportion() const override
        {
            return static_cast<double>(proportion);
        }
        // DocString: FMTEdgeProperties(const int&,const int&,const double&)
        FMTEdgeProperties(const int& laction,
            const int& lvariableID,
            const double& lproportion);
        // DocString: FMTEdgeProperties::operator==
        bool operator == (const FMTEdgeProperties& rhs) const;
        // DocString: FMTEdgeProperties::operator!=
        bool operator != (const FMTEdgeProperties& rhs) const;
        // DocString: FMTEdgeProperties::variableName
        inline std::string variableName() const;
        // DocString: FMTEdgeProperties::getVariablePtr
        inline const int* getVariablePtr() const
        {
            return &variableID;
        }
 
    };
}
 
BOOST_CLASS_EXPORT_KEY(Graph::FMTEdgeProperties)
 
#endif