goption.h

Go to the documentation of this file.

#ifndef  GOPTION_H
#define  GOPTION_H  1
 
// goption
#include "goptionsConventions.h"
 
// gemc
#include "gutsConventions.h"
 
// c++
#include <map>
#include <fstream>
#include <vector>
#include <string>
 
using std::string;
using std::map;
using std::vector;
 
// yaml-cpp
#include "yaml-cpp/yaml.h"
 
struct GVariable {
 
    string name;        
    string value;       
    string description; 
 
    GVariable(string n, string val, string d) : name(n), value(val), description(d) {}
 
    GVariable(string n, double val, string d) : name(n), description(d) { value = std::to_string(val); }
 
    GVariable(string n, const char *val, string d) : name(n), value(val), description(d) {}
 
    GVariable(string n, int val, string d) : name(n), description(d) { value = std::to_string(val); }
 
    GVariable(string n, bool val, string d) : name(n), description(d) { value = val ? "true" : "false"; }
};
 
class GOption {
public:
 
    GOption(GVariable dv, string h) : name(dv.name), description(dv.description), help(h) {
        defaultValue = YAML::Load(name + ": " + dv.value);
        value = defaultValue;
    }
 
 
    GOption(string n, string desc, vector <GVariable> dv, string h) : name(n), description(desc), help(h) {
 
        YAML::Node nodes;
        for (const auto &v: dv) {
            YAML::Node this_node = YAML::Load(v.name + ": " + v.value);
            nodes.push_back(this_node);
            gvar_descs.push_back(v.description);
            if (v.value == goptions::NODFLT) {
                isCumulative = true;
                mandatory_keys.push_back(v.name);
            }
        }
        defaultValue[n] = nodes;
 
        // if an option is not cumulative, the default value is copied to the first element of the sequence
        if (!isCumulative) {
            value = defaultValue;
        }
    }
 
private:
 
    bool isCumulative = false;          
    const string name;                  
    const string description;           
    const string help;                  
 
    // values is a map, containing either:
    // - a single scalar
    //   Example:
    //    runno: 14
    //
    // - a sequence of maps
    //   Example 1:
    //     gparticle:
    //       - pname: e-
    //         multiplicity: 1
    //   Example 2:
    //     verbosity:
    //       - fields: 1
    //       - particles: 2
 
 
    YAML::Node value;
 
 
    YAML::Node defaultValue;            
    vector <string> gvar_descs;          
    vector <string> mandatory_keys;      
 
 
    void saveOption(std::ofstream *yamlConf) const;
 
    void printHelp(bool detailed) const;
 
    string detailedHelp() const;
 
    void set_scalar_value(const string &v);
 
    void set_value(const YAML::Node &v);
 
    bool does_the_option_set_all_necessary_values(YAML::Node v);
 
    friend class GOptions; 
 
 
};
 
 
#endif