src/noarch/SettingFile.h (0fee1b0) - Blinker · BlinkenArea

SettingFile.h

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

#ifndef SETTINGFILE_H
#define SETTINGFILE_H

#include <string>

#include "File.h"

namespace Blinker {

/// file containting a single setting
template<typename TYPE>
class SettingFile: public File
{
public:
  /**
   * @brief constructor from path
   * @param[in] path path to file
   */
  SettingFile(const std::string &path);

/**
   * @brief constructor from basic file
   * @param[in] file basic file object
   */
  SettingFile(const File &file);

/**
   * @brief assignment operator
   * @param[in] file basic file object
   */
  const SettingFile & operator=(const File &file);

public:
  /// update, i.e. (re-)read file
  void update();

protected:
  /**
   * @brief get setting as string
   * @param[out] val setting read from file
   * @return if setting was successfully read from file
   */
  bool getStr(std::string& val) const;

public:
  TYPE m_obj;   ///< setting object read from file
  bool m_valid; ///< if setting object could be read and parsed
}; // class SettingFile

} // namespace Blinker

#endif // #ifndef SETTINGFILE_H

Blinker

implemented specialized setting files for different data types, simplified input/output stream handling in modules