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

   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 2, 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
  23 // Generate SWIG directors for gr_prefs.
  24 %feature("director") gr_prefs;
  25
  26 class gr_prefs
  27 {
  28 public:
  29   static gr_prefs *singleton();
  30   static void set_singleton(gr_prefs *p);
  31
  32   virtual ~gr_prefs();
  33
  34   /*!
  35    * \brief Does \p section exist?
  36    */
  37   virtual bool has_section(const std::string section);
  38
  39   /*!
  40    * \brief Does \p option exist?
  41    */
  42   virtual bool has_option(const std::string section, const std::string option);
  43
  44   /*!
  45    * \brief If option exists return associated value; else default_val.
  46    */
  47   virtual const std::string get_string(const std::string section,
  48                                        const std::string option,
  49                                        const std::string default_val);
  50
  51   /*!
  52    * \brief If option exists and value can be converted to bool, return it; else default_val.
  53    */
  54   virtual bool get_bool(const std::string section,
  55                         const std::string option,
  56                         bool default_val);
  57
  58   /*!
  59    * \brief If option exists and value can be converted to long, return it; else default_val.
  60    */
  61   virtual long get_long(const std::string section,
  62                         const std::string option,
  63                         long default_val);
  64
  65   /*!
  66    * \brief If option exists and value can be converted to double, return it; else default_val.
  67    */
  68   virtual double get_double(const std::string section,
  69                             const std::string option,
  70                             double default_val);
  71 };
  72