src/common/StreamFile.h (362c1f4) - Blinker · BlinkenArea

StreamFile.h

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

#ifndef BLINKER_STREAMFILE_H
#define BLINKER_STREAMFILE_H

#include "File.h"
#include "NameFile.h"
#include "Stream.h"
#include "StreamMgr.h"

namespace Blinker {

/// setting file containting a name of a stream
class StreamFile: public NameFile
{
public:
  /**
   * @brief constructor from path
   * @param[in] path path to file
   * @param[in] streamMgr stream manager
   */
  StreamFile(const std::string &path, StreamMgr &streamMgr);

/**
   * @brief constructor from basic file
   * @param[in] file basic file object
   * @param[in] streamMgr stream manager
   */
  StreamFile(const File &file, StreamMgr &streamMgr);

/// destructor
  ~StreamFile();

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

private:
  /// copy constructor disabled
  StreamFile(const StreamFile &that);

/// assignment operator disabled
  const StreamFile & operator=(const StreamFile &that);

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

protected:
  /// unreference stream
  void unref();

/// reference stream
  void ref();

protected:
  StreamMgr &m_streamMgr; ///< stream manager
  Stream    *m_pStream;   ///< stream
}; // class StreamFile

} // namespace Blinker

#endif // #ifndef BLINKER_STREAMFILE_H

Blinker

update copyright header