FMTyields.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 FMTYLD_H_INCLUDED
#define FMTYLD_H_INCLUDED
 
#include "FMTlist.hpp"
#include "FMTyieldhandler.hpp"
#include "FMTdevelopment.hpp"
#include "FMTbounds.hpp"
#include <vector>
#include <map>
#include <string>
#include <boost/serialization/serialization.hpp>
#include "FMTutility.hpp"
#include "FMTtheme.hpp"
#include <unordered_map>
#include <memory>
#include <boost/serialization/export.hpp>
#include "FMTyieldrequest.hpp"
 
 
namespace Core
{
class FMTdevelopment;
class FMTageyieldhandler;
class FMTtimeyieldhandler;
// DocString: FMTyields
class FMTEXPORT FMTyields : public FMTlist<std::unique_ptr<FMTyieldhandler>>
    {
    // 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));
            updateyieldpresence();
        }catch (...)
            {
            _exhandler->printexceptions("", "FMTyields::serialize", __LINE__, __FILE__);
            }
    }
    // DocString: FMTyields::yieldpresence
    std::unordered_map<std::string,bool>yieldpresence;
    // DocString: FMTyields::gethandleroftype
    std::vector<const FMTyieldhandler*> gethandleroftype(FMTyldtype type) const;
    // DocString: FMTyields::gethandleroftype
    std::vector<FMTyieldhandler*> gethandlers(FMTyldtype type);
    // DocString: FMTyields::getmaxbase
    int getmaxbase(const std::vector<const FMTyieldhandler*>& handlers) const;
    // DocString: FMTyields::updateyieldpresence
    void updateyieldpresence();
    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::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::presolve
        FMTyields presolve(const FMTmaskfilter& filter,
            const std::vector<FMTtheme>& originalthemes,
            const std::vector<FMTtheme>& newthemes) const;
        // 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::push_backagehandler
        void push_backagehandler(const FMTmask& mask, const FMTageyieldhandler& value);
        // DocString: FMTyields::push_backtimehandler
        void push_backtimehandler(const FMTmask& mask, const FMTtimeyieldhandler& value);
    };
}
BOOST_CLASS_EXPORT_KEY(Core::FMTyields)
#endif // FMTYLD_H_INCLUDED