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  *
  30  * The real implementation is in Python, and is accessable from C++
  31  * via the magic of SWIG directors.
  32  */
  33
  34 class gr_prefs
  35 {
  36 public:
  37   static gr_prefs *singleton();
  38   static void set_singleton(gr_prefs *p);
  39
  40   virtual ~gr_prefs();
  41
  42   /*!
  43    * \brief Does \p section exist?
  44    */
  45   virtual bool has_section(const std::string section);
  46
  47   /*!
  48    * \brief Does \p option exist?
  49    */
  50   virtual bool has_option(const std::string section, const std::string option);
  51
  52   /*!
  53    * \brief If option exists return associated value; else default_val.
  54    */
  55   virtual const std::string get_string(const std::string section,
  56                                        const std::string option,
  57                                        const std::string default_val);
  58
  59   /*!
  60    * \brief If option exists and value can be converted to bool, return it; else default_val.
  61    */
  62   virtual bool get_bool(const std::string section,
  63                         const std::string option,
  64                         bool default_val);
  65
  66   /*!
  67    * \brief If option exists and value can be converted to long, return it; else default_val.
  68    */
  69   virtual long get_long(const std::string section,
  70                         const std::string option,
  71                         long default_val);
  72
  73   /*!
  74    * \brief If option exists and value can be converted to double, return it; else default_val.
  75    */
  76   virtual double get_double(const std::string section,
  77                             const std::string option,
  78                             double default_val);
  79 };
  80
  81
  82 #endif /* INCLUDED_GR_PREFS_H */