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