FMTModelYieldHandler.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 FMTMODELYIELDHANDLER_Hm_included
#define FMTMODELYIELDHANDLER_Hm_included
 
#include "FMTYieldHandler.h"
#include <string>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <memory>
 
namespace Models
{
    class FMTModel;
};
 
namespace Core
{
    class FMTData;
    class FMTYieldModel;
    class FMTTimeYieldHandler;
    // DocString: FMTModelYieldHandler
    class FMTEXPORT FMTModelYieldHandler final : public FMTYieldHandler
    {
    public:
        // DocString: FMTModelYieldHandler::get
        virtual double get(const std::string& yld, const FMTYieldRequest& request) const;
        // DocString: FMTModelYieldHandler::operator std::string
        virtual  operator std::string() const;
        // DocString: ~FMTModelYieldHandler()
        ~FMTModelYieldHandler() = default;
        // DocString: FMTModelYieldHandler()
        FMTModelYieldHandler();
        // DocString: FMTModelYieldHandler(const FMTModelYieldHandler&)
        FMTModelYieldHandler(const FMTModelYieldHandler& rhs);
        // DocString: FMTModelYieldHandler::operator=
        FMTModelYieldHandler& operator = (const FMTModelYieldHandler& rhs);
        // DocString: FMTModelYieldHandler(const FMTMask&)
        FMTModelYieldHandler(const FMTMask& p_mask);
        // DocString: FMTModelYieldHandler::getModelsNameByIndex
        std::map<std::string, size_t>getModelsNameByIndex() const;
        // DocString: FMTModelYieldHandler::pushBackModel
        void pushBackModel(const std::unique_ptr<FMTYieldModel>& model);
        // DocString: FMTModelYieldHandler::setYield
        void setYield(const size_t& modelid,const size_t& yieldid,const std::string& yldname);
        // DocString: FMTModelYieldHandler::clone
        virtual std::unique_ptr<FMTYieldHandler>clone() const;
        // DocString: FMTModelYieldHandler::operator==
        virtual bool operator == (const FMTModelYieldHandler& rhs) const;
        // DocString: FMTModelYieldHandler::empty
        virtual bool empty() const;
        // DocString: FMTModelYieldHandler::size
        virtual size_t size() const;
        // DocString: FMTModelYieldHandler::getType
        virtual FMTyldtype getType() const;
        // DocString: FMTModelYieldHandler::containsYield
        virtual bool containsYield(const std::string& yldname) const;
        // DocString: FMTModelYieldHandler::isNullYield
        virtual bool isNullYield(const std::string& yldname) const;
        // DocString: FMTModelYieldHandler::getYieldNames
        virtual std::vector<std::string>getYieldNames() const;
        // DocString: FMTModelYieldHandler::clearCache
        virtual void clearCache();
        // DocString: FMTModelYieldHandler::preSolve
        virtual std::unique_ptr<FMTYieldHandler> preSolve(const FMTMaskFilter& filter, const std::vector<FMTTheme>& newthemes) const;
        // DocString: FMTModelYieldHandler::postSolve
        virtual std::unique_ptr<FMTYieldHandler> postSolve(const FMTMaskFilter& filter, const std::vector<FMTTheme>& basethemes) const;
        // DocString: FMTModelYieldHandler::clearRandomYieldsCache
        void clearRandomYieldsCache();
        // DocString: FMTModelYieldHandler::toTimeHandler
        FMTTimeYieldHandler toTimeHandler() const;
        // DocString: FMTModelYieldHandler::setModel
        void setModel(Models::FMTModel* p_modelPtr);
    private:
        friend class boost::serialization::access;
        // DocString: FMTModelYieldHandler::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& boost::serialization::make_nvp("FMTyieldhandler", boost::serialization::base_object<FMTYieldHandler>(*this));
            ar& m_yldnames;
        }
        std::vector<std::unique_ptr<FMTYieldModel>>m_models;
        std::map<std::string, std::pair<size_t, size_t>, cmpYieldString>m_yldnames;
    };
 
}
 
#endif