git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_prefs.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22 #ifndef INCLUDED_GR_PREFS_H
  23 #define INCLUDED_GR_PREFS_H
  24
  25 #include <string>
  26
  27 /*!
  28  * \brief Base class for representing user preferences a la windows INI files.
  29  * \ingroup misc
  30  *
  31  * The real implementation is in Python, and is accessable from C++
  32  * via the magic of SWIG directors.
  33  */
  34
  35 class gr_prefs
  36 {
  37 public:
  38   static gr_prefs *singleton();
  39   static void set_singleton(gr_prefs *p);
  40
  41   virtual ~gr_prefs();
  42
  43   /*!
  44    * \brief Does \p section exist?
  45    */
  46   virtual bool has_section(const std::string section);
  47
  48   /*!
  49    * \brief Does \p option exist?
  50    */
  51   virtual bool has_option(const std::string section, const std::string option);
  52
  53   /*!
  54    * \brief If option exists return associated value; else default_val.
  55    */
  56   virtual const std::string get_string(const std::string section,
  57                                        const std::string option,
  58                                        const std::string default_val);
  59
  60   /*!
  61    * \brief If option exists and value can be converted to bool, return it; else default_val.
  62    */
  63   virtual bool get_bool(const std::string section,
  64                         const std::string option,
  65                         bool default_val);
  66
  67   /*!
  68    * \brief If option exists and value can be converted to long, return it; else default_val.
  69    */
  70   virtual long get_long(const std::string section,
  71                         const std::string option,
  72                         long default_val);
  73
  74   /*!
  75    * \brief If option exists and value can be converted to double, return it; else default_val.
  76    */
  77   virtual double get_double(const std::string section,
  78                             const std::string option,
  79                             double default_val);
  80 };
  81
  82
  83 #endif /* INCLUDED_GR_PREFS_H */