FMTData.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 FMTDATA_Hm_included
#define FMTDATA_Hm_included
 
 
#include <vector>
#include <string>
#include <map>
#include "FMTutility.h"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/binary_object.hpp>
#include <boost/serialization/export.hpp>
#include <memory>
 
namespace Core
{
class FMTDevelopment;
class FMTYieldRequest;
class FMTExpression;
class FMTMask;
 
// DocString: FMTData
class FMTEXPORT FMTData
    {
    public:
        std::vector<double> data;
        // DocString: FMTData()
        FMTData();
        // DocString: ~FMTData()
        ~FMTData()=default;
        // DocString: FMTData(const FMTData&)
        FMTData(const FMTData& rhs);
        // DocString: FMTData(const std::vector<double>&,const FMTyieldparserop&,const std::vector<std::string>&)
        FMTData(const std::vector<double>& lvalues,
            const FMTyieldparserop& lops,
            const std::vector<std::string>& lsource);
        // DocString: FMTData(const std::vector<double>&,const FMTyieldparserop&,const std::vector<std::string>&,const std::vector<bool>&)
        FMTData(const std::vector<double>& lvalues,
                const FMTyieldparserop& lops,
                const std::vector<std::string>& lsource,
                const std::vector<bool>& varstack);
        // DocString: FMTData::operator=
        FMTData& operator = (const FMTData& rhs);
        // DocString: FMTData::getOp
        FMTyieldparserop getOp() const;
        // DocString: FMTData::clearCache
        void clearCache();
        // DocString: FMTData::constant
        bool constant() const;
        // DocString: FMTData::nullData
        bool nullData() const;
        // DocString: FMTData::cacheValue
        bool cacheValue(const FMTYieldRequest& request) const;
        // DocString: FMTData::get
        double get(const FMTYieldRequest& request) const;
        // DocString: FMTData::set
        void set(const double& value, const FMTYieldRequest& request, const bool& age_only) const;
        // DocString: FMTData::getSources
        std::vector<const std::string*> getSources() const;
        // DocString: FMTData::getSourcesCopy
        std::vector<std::string> getSourcesCopy() const;
        // DocString: FMTData::getValues
        std::vector<const double*>getValues() const;
        //std::vector<double>tovalues(const std::map<std::string, double>& sources) const;
        // DocString: FMTData::toExpression
        FMTExpression toExpression() const;
        // DocString: FMTData::operator==
        bool operator == (const FMTData& rhs) const;
        // DocString: FMTData::operator std::string
        operator std::string() const;
        // DocString: FMTData::operator*
        FMTData operator * (const double& factor) const;
    private:
        friend class boost::serialization::access;
        // DocString: FMTData::serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar& BOOST_SERIALIZATION_NVP(ops);
            ar& BOOST_SERIALIZATION_NVP(source);
            ar& BOOST_SERIALIZATION_NVP(stacking);
            ar& BOOST_SERIALIZATION_NVP(data);
        }
        FMTyieldparserop ops;
        std::vector<std::string>source;
        std::vector<bool>stacking;//Stacking a string = true stacking a number = false
        //mutable std::unique_ptr<boost::unordered_map<FMTDevelopment,double>> _cache; //hash base on (age and/or period and/or mask) //only for complex yield!!!!
        mutable std::unique_ptr<std::map<FMTDevelopment, double>> _cache; //hash base on (age and/or period and/or mask) //only for complex yield!!!!
        mutable bool _agebase;
        //size_t hashdata(const int& period, const int& age, const FMTMask& mask) const;
        // DocString: FMTData::getSummaryDevelopment
        FMTDevelopment getSummaryDevelopment(const FMTYieldRequest& request) const;
        // DocString: FMTData::allocateCache
        void allocateCache() const;
        // DocString: FMTData::deAllocateCache
        void deAllocateCache() const;
    };
}
 
BOOST_CLASS_EXPORT_KEY(Core::FMTData)
 
 
#endif // FMTDATA_Hm_included