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