FMTYields.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 FMTYLD_Hm_included
#define FMTYLD_Hm_included
 
#include "FMTList.hpp"
#include "FMTYieldHandler.h"
#include "FMTDevelopment.h"
#include "FMTBounds.hpp"
#include <vector>
#include <map>
#include <string>
#include <boost/serialization/serialization.hpp>
#include "FMTutility.h"
#include "FMTTheme.h"
#include <unordered_map>
#include <memory>
#include <boost/serialization/export.hpp>
#include "FMTYieldRequest.h"
 
namespace Models
{
    class FMTModel;
    class FMTNssModel;
}
 
 
namespace Core
{
class FMTDevelopment;
class FMTAgeYieldHandler;
class FMTTimeYieldHandler;
// DocString: FMTYields
class FMTEXPORT FMTYields : public FMTList<std::unique_ptr<FMTYieldHandler>>
    {
    friend class Models::FMTModel;
    friend class Models::FMTNssModel;
    public:
        // DocString: FMTYields::generateDefaultYields
        void generateDefaultYields(const std::vector<Core::FMTTheme>& themes);
        // DocString: FMTYields::swap
        void swap(FMTYields& rhs);
        // DocString: FMTYields::gotYieldType
        bool gotYieldType(FMTyldtype type) const;
        // DocString: FMTYields::setActionsMappingToModelHandlers
        void setActionsMappingToModelHandlers(const std::vector<int>& actionids);
        // DocString: FMTYields::getAllYieldNames
        std::vector<std::string> getAllYieldNames() const;
        // DocString: FMTYields()
        FMTYields();
        // DocString: ~FMTYields()
        ~FMTYields()=default;
        // DocString: FMTYields(const FMTYields&)
        FMTYields(const FMTYields& rhs);
        // DocString: FMTYields::operator=
        FMTYields& operator = (const FMTYields& rhs);
        // DocString: FMTYields::clearCache
        void clearCache() final;
        // DocString: FMTYields::clearRandomYieldsCache
        void clearRandomYieldsCache();
        // DocString: FMTYields::isYld
        bool isYld(const std::string& value,bool fromsource = false) const;
        // DocString: FMTYields::isNullYld
        bool isNullYld(const std::string& value) const;
        // DocString: FMTYields::get
        //std::vector<double>get(std::vector<FMTYieldRequest>& requests) const;
        // DocString: FMTYields::getSingle
        //double getSingle(const FMTDevelopment& dev,const std::string& target) const;
        //std::map<std::string,double>getYlds(const FMTDevelopment& dev,const FMTSpec& spec) const;
        // DocString: FMTYields::getYlds
        //std::vector<double>getYlds(const FMTDevelopment& dev, const FMTSpec& spec) const;
        // DocString: FMTYields::getAge
        int getAge(const FMTYieldRequest& request,const FMTSpec& spec) const;
        // DocString: FMTYields::getAllYields
        std::map<std::string, std::map<std::string, std::vector<double>>>getAllYields(const FMTTheme& target,FMTyldtype type) const;
        // DocString: FMTYields::operator==
        bool operator == (const FMTYields& rhs) const;
        // DocString: FMTYields::operator!=
        bool operator != (const FMTYields& rhs) const;
        // DocString: FMTYields::update
        void update() override;
        // DocString: FMTYields::reserve
        void reserve(const FMTYields& p_other);
        // DocString: FMTYields::preSolve
        FMTYields preSolve(const FMTMaskFilter& filter,
            const std::vector<FMTTheme>& originalthemes,
            const std::vector<FMTTheme>& newthemes) const;
        // DocString: FMTYields::preSolveRef
        void preSolveRef(const FMTMaskFilter& p_filter,
            const std::vector<FMTTheme>& p_originalThemes,
            const std::vector<FMTTheme>& p_newThemes);
        // DocString: FMTYields::getStacked
        std::vector<std::string>getStacked() const;
        // DocString: FMTYields::getFromFactor
        FMTYields getFromFactor(const double& factor,
            std::vector<std::string>yieldnames = std::vector<std::string>()) const;
        // DocString: FMTYields::get
        double get(const FMTYieldRequest& request,const std::string& yld) const;
        // DocString: FMTYields::pushBackAgeHandler
        void pushBackAgeHandler(const FMTMask& mask, const FMTAgeYieldHandler& value);
        // DocString: FMTYields::pushBackTimeHandler
        void pushBackTimeHandler(const FMTMask& mask, const FMTTimeYieldHandler& value);
        // DocString: FMTYields::getNullYield
        static const std::string& getNullYield();
        // DocString: FMTYields::getMaxBase
        static int getMaxBase(const std::vector<const FMTYieldHandler*>& handlers);
        // DocString: FMTYields::clear
        void clear();
    private:
        // DocString: FMTYields::serialize
        friend class boost::serialization::access;
        friend class FMTYieldRequest;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            try {
                ar& boost::serialization::make_nvp("handlers", boost::serialization::base_object<FMTList<std::unique_ptr<FMTYieldHandler>>>(*this));
                _updateYieldLocations();
            }
            catch (...)
            {
                _exhandler->printExceptions("", "FMTYields::serialize", __LINE__, __FILE__);
            }
        }
        // DocString: FMTYields::m_yieldsLocations
        std::unordered_map<std::string,size_t>m_yieldsLocations;
        // DocString: FMTYields::nullYield
        static const std::string m_nullYield;
        // DocString: FMTYields::_getHandlerOfType
        std::vector<const FMTYieldHandler*> _getHandlerOfType(FMTyldtype type) const;
        // DocString: FMTYields::_getHandlerOfType
        std::vector<FMTYieldHandler*> _getHandlers(FMTyldtype type);
        // DocString: FMTYields::_updateYieldLocations
        void _updateYieldLocations();
        // DocString: FMTYields::_setModel
        void _setModel(Models::FMTModel* p_modelPtr);
        // DocString: FMTYields::_getFirstSeen
        const_iterator _getFirstSeen(const std::string& p_yield) const;
    };
}
BOOST_CLASS_EXPORT_KEY(Core::FMTYields)
#endif // FMTYLD_Hm_included