ParamReader.h

Go to the documentation of this file.

/*
 * openSF Integration Libraries (OSFI)
 * Deimos Space, S.L.U.
 * 
 * This file is part of OSFI. OSFI is free software; you can redistribute it
 * and/or modify it under the terms of the 'ESA Software Community Licence Permissive' as
 * published by the European Space Agency; either version 2.4 of the License,
 * or (at your option) any later version. You should have received a
 * copy of the 'ESA Software Community Licence Permissive - v2.4' along with this program
 * or one can be found at <http://eop-cfi.esa.int/index.php/docs-and-mission-data/licensing-documents>.
 */
 
#ifndef OSFI_CONFM_PARAM_READER
#define OSFI_CONFM_PARAM_READER
 
#include <string>
#include <map>
#include <memory>
#include <vector>
#include <stdexcept>
 
using namespace std;
 
#include "Parameter.h"
#include "ArrayNode.h"
 
// TODO: this is performing the same comparison as std::less which is the default third argument to map anyway!
struct ltstr
{
    bool operator()(const string& s1, const string& s2) const
    {
        return s1.compare(s2) < 0;
    }
};
 
typedef map<string, Parameter, ltstr> t_params_map;
 
struct ParameterParsingException : public std::invalid_argument {
    ParameterParsingException(const string& msg) : std::invalid_argument(msg) {}
};
 
class XMLparser;
 
class ParamReader {
public:
 
    [[deprecated("Use the single-argument version and then call validate.")]]
    ParamReader(const string& xmlFile, const string& xsdFile);
    ParamReader(const std::string& xmlFile);
 
    ParamReader(const ParamReader& other);
    ParamReader(ParamReader&& other) = default;
 
    bool validateAgainst(const std::string& xsdFile) const;
    bool validateAgainstInternalSchema() const;
 
    virtual ~ParamReader();
 
    Parameter getParameter(const string& paramName) const;
 
    vector<Parameter> getParameters(const string& groupName) const;
 
    t_params_map getParameters() const;
 
    bool existParameter(const string& paramName) const;
 
 
    [[deprecated("Deprecated as OSFI is intended for reading configuration files.")]]
    void setParameter(const string& paramName, string value);
 
    void print() const;
 
    Parameter& getParameterRef(const string& path);
    const Parameter& getParameterRef(const string& path) const;
 
private:
 
    t_params_map _params;
    std::unique_ptr<XMLparser> src_doc;
};
 
#endif // OSFI_CONFM_PARAM_READER