FMTAgeYieldHandler.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 FMTAGEYIELDHANDLER_Hm_included
#define FMTAGEYIELDHANDLER_Hm_included
 
#include "FMTYieldHandler.h"
#include <string>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include "FMTData.h"
 
namespace Core
{
    // DocString: FMTAgeYieldHandler
    class FMTEXPORT FMTAgeYieldHandler : public FMTYieldHandler
    {
    public:
        // DocString: FMTAgeYieldHandler::get
        virtual double get(const std::string& yld, const FMTYieldRequest& request) const;
        // DocString: FMTAgeYieldHandler::operator std::string
        virtual  operator std::string() const;
        // DocString: ~FMTAgeYieldHandler()
        ~FMTAgeYieldHandler() = default;
        // DocString: FMTAgeYieldHandler()
        FMTAgeYieldHandler() = default;
        // DocString: FMTAgeYieldHandler(const FMTAgeYieldHandler&)
        FMTAgeYieldHandler(const FMTAgeYieldHandler& rhs) = default;
        // DocString: FMTAgeYieldHandler::operator=
        FMTAgeYieldHandler& operator = (const FMTAgeYieldHandler& rhs) = default;
        // DocString: FMTAgeYieldHandler(const FMTYieldHandler&)
        FMTAgeYieldHandler(const FMTYieldHandler& rhs);
        // DocString: FMTAgeYieldHandler(const FMTMask&)
        FMTAgeYieldHandler(const FMTMask& p_mask);
        // DocString: FMTAgeYieldHandler::setYieldValues
        virtual void setYieldValues(const std::string& yldname,const std::vector<int>& baseages,const std::vector<double>& values); 
        // DocString: FMTAgeYieldHandler::getLastValue
        virtual double getLastValue(const std::string yld) const;
        // DocString: FMTAgeYieldHandler::pushData(const std::string&, const double&)
        virtual bool pushData(const std::string& yld, const double& value);
        // DocString: FMTAgeYieldHandler::pushData(const std::string&, const FMTData&)
        virtual bool pushData(const std::string& yld, const FMTData& data);
        // DocString: FMTAgeYieldHandler::clone
        virtual std::unique_ptr<FMTYieldHandler>clone() const;
        // DocString: FMTAgeYieldHandler::operator==
        virtual bool operator == (const FMTAgeYieldHandler& rhs) const;
        // DocString: FMTAgeYieldHandler::empty
        virtual bool empty() const;
        // DocString: FMTAgeYieldHandler::size
        virtual size_t size() const;
        // DocString: FMTAgeYieldHandler::getType
        virtual FMTyldtype getType() const;
        // DocString: FMTAgeYieldHandler::operator[]
        virtual FMTData& operator[](const std::string& yldname);
        // DocString: FMTAgeYieldHandler::at
        virtual const FMTData& at(const std::string& yldname) const;
        // DocString: FMTAgeYieldHandler::containsYield
        virtual bool containsYield(const std::string& yldname) const;
        // DocString: FMTAgeYieldHandler::getYieldNames
        virtual std::vector<std::string>getYieldNames() const;
        // DocString: FMTAgeYieldHandler::clearCache
        virtual void clearCache();
        // DocString: FMTAgeYieldHandler::getAllYieldsData
        virtual std::map<std::string, std::vector<double>>getAllYieldsData(const int& maxbase)const;
        // DocString: FMTAgeYieldHandler::getFromFactor
        virtual std::unique_ptr<FMTYieldHandler> getFromFactor(const double& factor,
            std::vector<std::string>yieldnames = std::vector<std::string>()) const;
        // DocString: FMTAgeYieldHandler::getEndPoint
        virtual int getEndPoint(const std::string& yld, const int& lowerstep, const double& bound, const double& value) const;
        // DocString: FMTAgeYieldHandler::getPeak
        virtual double getPeak(const FMTYieldRequest& request,const std::string& yld, const int& targetage) const;
        // DocString: FMTAgeYieldHandler::getPeakfrom
        virtual double getPeakfrom(const std::string& yld, double maxvalue = std::numeric_limits<double>::lowest()) const;
        // DocString: FMTAgeYieldHandler::getAge(const FMTYieldRequest&, const FMTSpec&)
        virtual int getAge(const FMTYieldRequest& request, const FMTSpec& spec) const;
        // DocString: FMTAgeYieldHandler::getYieldLinearValue
        virtual double getYieldLinearValue(const std::string&yldname, const FMTYieldRequest& request, bool allowoutofrange=true) const;
    private:
        friend class boost::serialization::access;
        // DocString: FMTAgeYieldHandler::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;
        // DocString: FMTAgeYieldHandler::_getAge(const std::string, const double&, const int&)
        int _getAge(const std::string yld, const double& value, const int& starting_age) const;
    };
 
}
 
#endif