Defaults_Text.h

Go to the documentation of this file.

//
//
// File: hitfit/Defaults_Text.h
// Purpose: A lightweight implementation of the Defaults interface
//          that uses simple text files.
// Created: Jul, 2000, sss.
//
// Create instances of these objects passing in the name of a file.
// Each line of the file should contain a parameter setting like
//
//   NAME = VALUE
//
// Anything following a `;' or `#' is stried off; leading and trailing
// spaces on VALUE are also removed.  Blank lines are ignored.
//
// You can also pass an argument list to the constructor.  After the
// defaults file is read, the argument list will be scanned, to possibly
// override some of the parameter settings.  An argument of the form
//
//   --NAME=VALUE
//
// is equivalent to the parameter setting
//
//     NAME=VALUE
//
// while
//
//   --NAME
//
// is equivalent to
//
//   NAME=1
//
// and
//
//   --noNAME
//
// is equivalent to
//
//   NAME=0
//
// CMSSW File      : interface/Defaults_Text.h
// Original Author : Scott Stuart Snyder <snyder@bnl.gov> for D0
// Imported to CMSSW by Haryo Sumowidagdo <Suharyo.Sumowidagdo@cern.ch>
//

#ifndef HITFIT_DEFAULTS_TEXT_H
#define HITFIT_DEFAULTS_TEXT_H

#include <string>
#include <iosfwd>
#include "TopQuarkAnalysis/TopHitFit/interface/Defaults.h"

namespace hitfit {

  class Defaults_Textrep;

  class Defaults_Text : public Defaults
  //
  // Purpose: A lightweight implementation of the Defaults interface
  //          that uses simple text files.
  //
  {
  public:
    // Constructor, destructor.

    Defaults_Text(std::string def_file);

    Defaults_Text(std::string def_file, int argc, char** argv);

    ~Defaults_Text() override;

    // Test to see if parameter NAME exists.
    bool exists(std::string name) const override;

    // Get the value of NAME as an integer.
    int get_int(std::string name) const override;

    // Get the value of NAME as a boolean.
    bool get_bool(std::string name) const override;

    // Get the value of NAME as a float.
    double get_float(std::string name) const override;

    // Get the value of NAME as a string.
    std::string get_string(std::string name) const override;

    // Dump out all parameters.
    friend std::ostream& operator<<(std::ostream& s, const Defaults_Text& def);

  private:
    // The internal representation.
    Defaults_Textrep* _rep;
  };

}  // namespace hitfit

#endif  // not HITFIT_DEFAULTS_TEXT_H