FMTTimeYieldHandler.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 FMTTIMEYIELDHANDLER_Hm_included
#define FMTTIMEYIELDHANDLER_Hm_included
 
#include "FMTYieldHandler.h"
#include "FMTData.h"
#include <string>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
 
namespace Core
{
    
    // DocString: FMTTimeYieldHandler
    class FMTEXPORT FMTTimeYieldHandler final : public FMTYieldHandler
    {
    public:
        // DocString: FMTTimeYieldHandler::get
        virtual double get(const std::string& yld, const FMTYieldRequest& request) const;
        // DocString: FMTTimeYieldHandler::operator std::string
        virtual  operator std::string() const;
        // DocString: ~FMTTimeYieldHandler()
        ~FMTTimeYieldHandler() = default;
        // DocString: FMTTimeYieldHandler()
        FMTTimeYieldHandler() = default;
        // DocString: FMTTimeYieldHandler(const FMTTimeYieldHandler&)
        FMTTimeYieldHandler(const FMTTimeYieldHandler& rhs) = default;
        // DocString: FMTTimeYieldHandler::operator=
        FMTTimeYieldHandler& operator = (const FMTTimeYieldHandler& rhs) = default;
        // DocString: FMTTimeYieldHandler(const FMTMask&)
        FMTTimeYieldHandler(const FMTMask& p_mask);
        // DocString: FMTTimeYieldHandler::setYieldValues
        virtual void setYieldValues(const std::string& yldname,const int& startingperiod,const std::vector<double>& values);    
        // DocString: FMTTimeYieldHandler::getLastValue
        virtual double getLastValue(const std::string yld) const;
        // DocString: FMTTimeYieldHandler::pushData(const std::string&, const double&)
        virtual bool pushData(const std::string& yld, const double& value);
        // DocString: FMTTimeYieldHandler::pushData(const std::string&, const FMTData&)
        virtual bool pushData(const std::string& yld, const FMTData& data);
        // DocString: FMTTimeYieldHandler::clone
        virtual std::unique_ptr<FMTYieldHandler>clone() const;
        // DocString: FMTTimeYieldHandler::operator==
        virtual bool operator == (const FMTTimeYieldHandler& rhs) const;
        // DocString: FMTTimeYieldHandler::empty
        virtual bool empty() const;
        // DocString: FMTTimeYieldHandler::size
        virtual size_t size() const;
        // DocString: FMTTimeYieldHandler::getType
        virtual FMTyldtype getType() const;
        // DocString: FMTTimeYieldHandler::operator[]
        virtual FMTData& operator[](const std::string& yldname);
        // DocString: FMTTimeYieldHandler::at
        virtual const FMTData& at(const std::string& yldname) const;
        // DocString: FMTTimeYieldHandler::containsYield
        virtual bool containsYield(const std::string& yldname) const;
        // DocString: FMTTimeYieldHandler::getYieldNames
        virtual std::vector<std::string>getYieldNames() const;
        // DocString: FMTTimeYieldHandler::clearCache
        virtual void clearCache();
        // DocString: FMTTimeYieldHandler::getAllYieldsData
        virtual std::map<std::string, std::vector<double>>getAllYieldsData(const int& maxbase)const;
        // DocString: FMTTimeYieldHandler::getFromFactor
        virtual std::unique_ptr<FMTYieldHandler> getFromFactor(const double& factor,
            std::vector<std::string>yieldnames = std::vector<std::string>()) const;
    private:
        friend class boost::serialization::access;
        // DocString: FMTTimeYieldHandler::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& BOOST_SERIALIZATION_NVP(m_elements);
        }
        std::map<std::string, FMTData, cmpYieldString>m_elements;
    };
 
}
 
#endif