FMTmodelparameters.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
*/
 
#ifndef FMTmodelparameters_H_INCLUDED
#define FMTmodelparameters_H_INCLUDED
 
#include "FMTexceptionhandler.hpp"
#include "FMTobject.hpp"
#include <boost/serialization/export.hpp>
#include <boost/serialization/array.hpp>
#include <boost/serialization/vector.hpp>
#include <array>
#include <vector>
 
namespace Models
{
    //DocString: FMTintmodelparameters
    //
    enum FMTintmodelparameters
    {
        LENGTH = 0,
        SEED = 1, 
        NUMBER_OF_ITERATIONS = 2,
        PRESOLVE_ITERATIONS = 3,
        NUMBER_OF_THREADS = 4,
        MATRIX_TYPE = 5,
        UPDATE = 6,
        LastIntModelParam = 7
    };
    //DocString: FMTdblmodelparameters
    //
    enum FMTdblmodelparameters
    {
        TOLERANCE = 0,
        GOALING_SCHEDULE_WEIGHT = 1,
        LastDblModelParam = 2
    };
    //DocString: FMTboolmodelparameters
    //
    enum FMTboolmodelparameters
    {
        FORCE_PARTIAL_BUILD = 0,
        STRICTLY_POSITIVE = 1,
        POSTSOLVE = 2,
        SHOW_LOCK_IN_SCHEDULES = 3,//Not needed or change parameters in fonctions ... maybe more for task
        PRESOLVE_CAN_REMOVE_STATIC_THEMES =4,//The presolve will allow the removing of static themes even in use (it can alter the area section).
        DEBUG_MATRIX = 5,//If true, when an error occur in lpmodel initialsolve or resolve, the matrix will be written. 
        LastBoolModelParam = 6
    };
 
 
    // DocString: FMTmodelparameters
    class FMTEXPORT FMTmodelparameters : public Core::FMTobject
    {
        friend class boost::serialization::access;
        // DocString: FMTmodelparameters::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            try {
                ar& boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTobject>(*this));
                ar& BOOST_SERIALIZATION_NVP(intparameters);
                ar& BOOST_SERIALIZATION_NVP(dblparameters);
                ar& BOOST_SERIALIZATION_NVP(boolparameters);
                ar& BOOST_SERIALIZATION_NVP(compresstime);
            }
            catch (...)
            {
                _exhandler->printexceptions("", "FMTmodelparameters::serialize", __LINE__, __FILE__);
            }
        }
        private:
            std::array<int, LastIntModelParam> intparameters;
            std::array<double, LastDblModelParam> dblparameters;
            std::array<bool, LastBoolModelParam> boolparameters;
            std::vector<int> compresstime;
        public:
            // DocString: FMTmodelparameters()
            FMTmodelparameters();
            // DocString: FMTmodelparameters(const FMTmodelparameters&)
            FMTmodelparameters(const FMTmodelparameters& rhs);
            // DocString: FMTmodelparameters::operator=(const FMTmodelparameters&)
            FMTmodelparameters& operator = (const FMTmodelparameters& rhs); 
            // DocString: ~FMTmodelparameters
            ~FMTmodelparameters()=default;
            // DocString: FMTmodelparameters(FMTmodelparameters&&)
            FMTmodelparameters(FMTmodelparameters&& rhs)=default;
            // DocString: FMTmodelparameters::operator=(FMTmodelparameters&& rhs) 
            FMTmodelparameters& operator =(FMTmodelparameters&& rhs) =default;
            //###Setter
            bool setintparameter(const FMTintmodelparameters& key,const int& value);
            bool setdblparameter(const FMTdblmodelparameters& key,const double& value);
            bool setboolparameter(const FMTboolmodelparameters& key,const bool& value);
            bool setperiodcompresstime(const int& period, const int& value);
            //###Getter
            int getintparameter(const FMTintmodelparameters& key) const;
            double getdblparameter(const FMTdblmodelparameters& key) const;
            bool getboolparameter(const FMTboolmodelparameters& key) const;
            int getperiodcompresstime(const int& period)const;
            std::vector<int> getcompresstime() const;
    };
}
BOOST_CLASS_EXPORT_KEY(Models::FMTmodelparameters)
#endif // FMTmodelparameters_H_INCLUDED