rootana/src/framework/ModulesOptions.h

Go to the documentation of this file.

#ifndef MODULESOPTIONS__HH_
#define MODULESOPTIONS__HH_
#include <map>
#include <vector>
#include <string>
#include <utility>
#include <stdexcept>

namespace modules{
    class options;
    class missing_option;
    class bad_value;
}

struct modules::missing_option:public std::runtime_error{
    missing_option(const std::string& name, const std::string& opt):
        std::runtime_error(("Missing option for '"+name+"': '"+opt+"'" ).c_str()){};
};


struct modules::bad_value:public std::out_of_range{
    bad_value(const char* module, const char* name, const char* range, double val);
};

class modules::options{
    public:
        typedef std::map<std::string,std::string> OptionsList_t;
        typedef std::vector<OptionsList_t::iterator> OptionsOrder_t;

    public:
        //receive these options should be passed in
        options(const std::string& name):fModuleName(name){
            fIdNumber=MakeIdNumber();
        };
        virtual ~options(){};

        std::string StringDescription()const;

        /*-------------  Used by modules::reader -------------*/

        void SetOption(const std::string& key, const std::string& value);

        bool AppendToOption(const std::string& key, const std::string& value);

        void AddArgument(const int& number, const std::string& value);

        /*-------------  Used to retrieve values -------------*/

        int GetInt(const std::string& name,int defVal, const std::string& range="")const;

        double GetDouble(const std::string& name,double defVal, const std::string& range="")const;

        std::string GetString(const std::string& name,const std::string& defVal)const;

        bool GetBool(const std::string& name, bool defVal)const;

        int GetInt(const std::string& name, const std::string& range="")const;

        double GetDouble(const std::string& name, const std::string& range="")const;

        std::string GetString(const std::string& name)const;

        bool GetBool(const std::string& name)const;

        int GetVectorStringsByWhiteSpace(const std::string& name, std::vector<std::string>& vect)const;

        int GetVectorStringsByDelimiter(const std::string& name, std::vector<std::string>& vect,const char* delim=":")const;

        bool HasOption(const std::string& name)const;

        bool GetFlag(const std::string& name)const;

        bool GetNumOptions()const{return fOptions.size();};

        std::string GetOption(const std::string& name, bool complain=false)const;

        OptionsList_t::const_iterator begin()const{return fOptions.begin();};
        OptionsList_t::const_iterator end()const{return fOptions.end();};

        //OptionsList_t::iterator begin(){return fOptions.begin();};
        //OptionsList_t::iterator end(){return fOptions.end();};

        void DumpOptions(const std::string& prefix="     ")const;

        void SetAlias(const std::string& alias){SetOption("alias",alias);};
        std::string GetAlias(const std::string& defVal="")const{return GetString("alias",defVal);};


    private:
        template <typename T>
            T GetOption(const std::string& name,const T& defVal, bool complain,const std::string& range="")const;

        static int MakeIdNumber();

        void CheckValid(const std::string& name, const char* expression, double value)const;

    private:
        OptionsList_t fOptions;
        OptionsOrder_t fOrder;
        int fIdNumber;

    protected:
        std::string fModuleName;

};

inline void modules::options::SetOption(const std::string& name, const std::string& option){
    // if a new key was added, store an iterator in the order list
    OptionsList_t::iterator it = fOptions.find(name);
    fOptions[name]=option;
    if(it==fOptions.end()) fOrder.push_back(fOptions.find(name));
}

inline bool modules::options::HasOption(const std::string& name)const{
    return fOptions.find(name)!=fOptions.end();
}

inline bool modules::options::GetFlag(const std::string& name)const{
    return (HasOption(name) && (GetOption(name).empty() || GetBool(name)));
}

#endif  //MODULESOPTIONS__HH_

---