InputParameters.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include <cerrno>
#include <iterator>
#include <utility>
 
#include "common/containers/CepsMap.hpp"
#include "common/toolbox/FileReader.hpp"
 
class InputParameters : public FileReader
{
  
  using keyType = CepsString;
 
  public:
 
    InputParameters();
  
    explicit InputParameters(const CepsString& inputFile, CepsBool warnDefault = false);
  
    InputParameters(const InputParameters& that) = default;
  
    InputParameters&
    operator=(const InputParameters& that) = default;
  
    ~InputParameters() override;
  
    void
    read();
  
    // Get values from input file, no default value
  
    CepsReal
    getReal(const keyType& key) const;
  
    CepsMathVertex
    getMathVertex(const keyType& key) const;
  
    CepsInt
    getInt(const keyType& key) const;
  
    CepsString
    getString(const keyType& key) const;
  
    CepsString
    operator()(const keyType& key) const;
  
    // Same with default values
  
    CepsReal
    getReal(const keyType& key, const CepsReal& dval) const;
  
    CepsMathVertex
    getMathVertex(const keyType& key, const CepsMathVertex& dval) const;
  
    CepsInt
    getInt(const keyType& key, const CepsInt& dval) const;
  
    CepsString
    getString(const keyType& key, const CepsString& dval) const;
  
    CepsString
    operator()(const keyType& key, const CepsString& dval) const;
  
    // Change config
  
    void
    set(const keyType& key, const CepsString& value);
  
    void
    set(const keyType& key, const CepsReal& value);
  
    void
    set(const keyType& key, const CepsInt& value);
  
    void
    erase(const keyType& key);
  
    // Quick information
  
    CepsBool
    hasKey(const keyType& key) const;
  
    CepsBool
    isActiveOption(const keyType& key) const;
  
    CepsBool
    isInactiveOption(const keyType& key) const;
 
 
  protected:
 
    void
    errIfNoKey(const keyType& key, const CepsString& type) const;
  
    void
    warnNoKey(const keyType& key, const CepsString& defValue, const CepsString& type) const;
  
 
  private:
 
    CepsMap<keyType,CepsString> m_keyVals;      
    CepsBool                    m_warnDefault;  
 
};