FMTBaseEdgeProperties.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 FMTbaseedgeproperties_Hm_included
#define FMTbaseedgeproperties_Hm_included
 
 
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
#include <vector>
#include <string>
#include <cstdint>
 
namespace Core
{
    class FMTAction;
}
 
namespace Graph
{
    // DocString: FMTBaseEdgeProperties
    class FMTBaseEdgeProperties
    {
    public:
        // DocString: ~FMTBaseEdgeProperties()
        virtual ~FMTBaseEdgeProperties() = default;
        // DocString: FMTBaseEdgeProperties()
        FMTBaseEdgeProperties()=default;
        // DocString: FMTBaseEdgeProperties(const FMTBaseEdgeProperties&)
        FMTBaseEdgeProperties(const FMTBaseEdgeProperties& rhs)=default;
        // DocString: FMTBaseEdgeProperties::operator=
        FMTBaseEdgeProperties& operator = (const FMTBaseEdgeProperties& rhs)=default;
        // DocString: FMTBaseEdgeProperties(const int&,const int&,const double&)
        FMTBaseEdgeProperties(const int& laction,
                        const int& lvariableID,
                        const double& lproportion);
        // DocString: FMTBaseEdgeProperties(const int&)
        constexpr FMTBaseEdgeProperties(const int& laction) : action(static_cast<int8_t>(laction)) {}
        // DocString: FMTBaseEdgeProperties::getVariableID
        virtual inline int  getVariableID() const
            {
            return 0;
            }
        // DocString: FMTBaseEdgeProperties::getProportion
        virtual inline double getProportion() const
            {
            return 100;
            }
        // DocString: FMTBaseEdgeProperties::getActionID
        inline int getActionID() const
            {
            return static_cast<int>(action);
            }
        // DocString: FMTBaseEdgeProperties::getShortActionID
        inline int8_t getShortActionID() const
            {
            return action;
            }
        // DocString: FMTBaseEdgeProperties::setActionID
        void setActionID(const int& newid);
        // DocString: FMTBaseEdgeProperties::isAction
        bool isAction(const std::vector<Core::FMTAction>& actions,
            const Core::FMTAction& rhsaction) const;
        // DocString: FMTBaseEdgeProperties::operator==
        /*virtual*/ bool operator == (const FMTBaseEdgeProperties & rhs) const;
        // DocString: FMTBaseEdgeProperties::operator!=
        /*virtual*/ bool operator != (const FMTBaseEdgeProperties& rhs) const;
        // DocString: FMTBaseEdgeProperties::operator<
        bool operator < (const FMTBaseEdgeProperties& rhs) const;
        /*inline const short int* getactionptr() const
            {
            return &action;
            }*/
 
    protected:
        int8_t action;
    private:
        friend class boost::serialization::access;
        // DocString: FMTBaseEdgeProperties::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & BOOST_SERIALIZATION_NVP(action);
        }
    };
}
 
BOOST_CLASS_EXPORT_KEY(Graph::FMTBaseEdgeProperties)
 
#endif