BeanLike.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
#ifndef DRAIN_BEANLIKE_H_
#define DRAIN_BEANLIKE_H_
 
//
#include <cmath>
 
#include <vector>
#include <iostream>
#include <stdexcept>
#include <map>
 
#include <drain/Log.h>
#include <drain/StringBuilder.h>
//#include <drain/VariableAssign.h>
// #include "Variable.h"
#include "ReferenceMap.h"
 
 
namespace drain
{
 
 
 
class BeanLike {
 
public:
 
    virtual inline
    ~BeanLike(){};
 
    virtual inline
    const std::string & getName() const { return name; };
 
 
    virtual inline
    const std::string & getDescription() const {
        return description;
    };
 
    inline
    bool hasParameters() const {
        return !parameters.empty();
    };
 
    template <class F>
    F getParameter(const std::string & p) const {
        if (parameters.hasKey(p))
            return parameters[p];
        else {
            throw std::runtime_error(p + ": no such parameter (BeanLike::getParameter)");
        }
    }
 
    inline
    const ReferenceMap & getParameters() const { return parameters; };
 
    inline
    ReferenceMap & getParameters() { return parameters; };
 
 
    template <class F>
    inline
    void setParametersFromEntries(const F & args){
 
        ReferenceMap & parameters = getParameters();
        std::stringstream sstr;
        char separator = 0;
        for (const auto & entry: args){
            parameters[entry.first] = entry.second;
            // setParameter(entry.first, entry.second);
            if (separator)
                sstr << separator;
            else
                separator = ',';
            sstr << entry.first << '=' << entry.second;
        }
        storeLastArguments(sstr.str());
 
        updateBean();
 
    }
 
    /*
    inline
    void shareParameters(ReferenceMap & rmap) {
        return rmap.append(parameters);
    };
    */
    inline
    void setParameters(std::initializer_list<Variable::init_pair_t > args){
 
        setParametersFromEntries(args);
 
        /*
        ReferenceMap & parameters = getParameters();
        std::stringstream sstr;
        char separator = 0;
        for (const auto & entry: args){
            parameters[entry.first] = entry.second;
            // setParameter(entry.first, entry.second);
            if (separator)
                sstr << separator;
            else
                separator = ',';
            sstr << entry.first << '=' << entry.second;
        }
        storeLastArguments(sstr.str());
        */
 
        /*
        for (const auto & entry: args){
            setParameter(entry.first, entry.second);
            //parameters[entry.first] = entry.second;
        }
        */
    }
 
 
    virtual inline
    void setParameters(const std::string &p, char assignmentSymbol='=', char separatorSymbol=0){
        parameters.setValues(p, assignmentSymbol, separatorSymbol);
        updateBean();
        storeLastArguments(p); // experimental
    };
 
 
    template <class T>
    inline
    void setParameters(const std::map<std::string,T> & args){
        setParametersFromEntries(args);
        /*
        parameters.importMap(p);
        updateBean();
        */
    }
 
 
    template <class T>
    inline
    void setParameters(const SmartMap<T> & args){  // NEEDED?
        setParametersFromEntries(args);
        /*
        parameters.importCastableMap(p);
        updateBean();
        */
    }
 
    inline
    void setParameter(const std::string &p, const Castable & value){
        parameters[p].assignCastable(value);
        updateBean();
        storeLastArguments(StringBuilder<'='>(p, value)); // experimental
    }
 
    template <class T>
    inline
    void setParameter(const std::string &p, const VariableT<T> & value){
        parameters[p].assignCastable(value);
        updateBean();
        storeLastArguments(StringBuilder<'='>(p, value)); // experimental
    }
 
    /*
    inline
    void setParameter(const std::string &p, const Reference & value){
        parameters[p].assignCastable(value);
        updateBean();
    }
    */
 
    template <class F>
    inline
    void setParameter(const std::string &p, const F &value){
        parameters[p] = value;
        updateBean();
        // storeLastArguments(p); // experimental
        storeLastArguments(StringBuilder<'='>(p, value));
    }
 
    template <class F>
    inline
    void setParameter(const std::string &p, std::initializer_list<F> value){
        parameters[p] = value;
        updateBean();
        // develop storeLastParameters(StringBuilder<'='>(p, value)); // experimental
    }
 
 
 
    inline
    BeanLike & operator=(const BeanLike & b){ //
        parameters.importMap(b.getParameters()); // 2021
        updateBean(); // ADDED 2021/10
        return *this;
    }
 
 
    virtual
    std::ostream & toStream(std::ostream & ostr, bool compact = true) const;
 
    /*
    virtual inline
    std::ostream & toStream(std::ostream & ostr) const {
        //ostr << name << ':' << parameters;
        ostr << name << ": " << description << '\n';
        ostr << '\t' << parameters << '\n';
        return ostr;
    }
    */
 
// 2024 public:
    BeanLike(const BeanLike & b) : name(b.name), description(b.description){
        // copy(b);
        parameters.copyStruct(b.getParameters(), b, *this, ReferenceMap::RESERVE);
    }
 
 
    BeanLike(const std::string & name, const std::string & description="") : name(name), description(description) {
    }
 
protected:
 
 
 
    const std::string name;  // todo separate (Beanlet)
 
    const std::string description; // todo separate (Beanlet)
 
    ReferenceMap parameters;  // todo separate (Beanlet)
 
    virtual inline
    void storeLastArguments(const std::string & p){};
 
    virtual inline
    void updateBean() const {};
 
 
 
};
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const BeanLike & bean){
    bean.toStream(ostr);
    return ostr;
}
 
}
 
 
#endif
 
// Drain