Blinker

1) /* Blinker
2)    Copyright 2011 Stefan Schuermans <stefan@blinkenarea.org>
3)    Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html
4)    a blinkenarea.org project */
5) 

6) #ifndef BLINKER_SETTINGFILE_H
7) #define BLINKER_SETTINGFILE_H

8) 
9) #include <string>
10) 
11) #include "File.h"
12) 
13) namespace Blinker {
14) 
15) /// file containting a single setting

16) template<typename TYPE>

17) class SettingFile: public File
18) {
19) public:
20)   /**
21)    * @brief constructor from path
22)    * @param[in] path path to file
23)    */
24)   SettingFile(const std::string &path);
25) 
26)   /**
27)    * @brief constructor from basic file
28)    * @param[in] file basic file object
29)    */
30)   SettingFile(const File &file);
31) 
32)   /**
33)    * @brief assignment operator
34)    * @param[in] file basic file object
35)    */
36)   const SettingFile & operator=(const File &file);
37) 
38) public:

39)   /// update, i.e. (re-)read file
40)   void update();
41) 
42) protected:

43)   /**
44)    * @brief get setting as string
45)    * @param[out] val setting read from file
46)    * @return if setting was successfully read from file
47)    */

48)   bool getStr(std::string& val) const;
49) 
50) public:
51)   TYPE m_obj;   ///< setting object read from file
52)   bool m_valid; ///< if setting object could be read and parsed

53) }; // class SettingFile
54) 
55) } // namespace Blinker
56) 

57) #endif // #ifndef BLINKER_SETTINGFILE_H