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_INSTREAMFILE_H
7) #define BLINKER_INSTREAMFILE_H

8) 
9) #include "File.h"
10) #include "StreamFile.h"
11) #include "StreamMgr.h"
12) #include "StreamRecv.h"
13) 
14) namespace Blinker {
15) 
16) /// setting file containting a name of an input stream
17) class InStreamFile: public StreamFile
18) {
19) public:
20)   /**
21)    * @brief constructor from path
22)    * @param[in] path path to file
23)    * @param[in] streamMgr stream manager
24)    */
25)   InStreamFile(const std::string &path, StreamMgr &streamMgr);
26) 
27)   /**
28)    * @brief constructor from basic file
29)    * @param[in] file basic file object
30)    * @param[in] streamMgr stream manager
31)    */
32)   InStreamFile(const File &file, StreamMgr &streamMgr);
33) 
34)   /// destructor
35)   ~InStreamFile();
36) 
37)   /**
38)    * @brief assignment operator
39)    * @param[in] file basic file object
40)    */
41)   const InStreamFile & operator=(const File &file);
42) 

43) private:
44)   /// copy constructor disabled
45)   InStreamFile(const InStreamFile &that);
46) 
47)   /// assignment operator disabled
48)   const InStreamFile & operator=(const InStreamFile &that);
49) 

50) public:
51)   /**
52)    * @brief set stream receiver
53)    * @param[in] pStreamRecv stream reciver (NULL if none)
54)    */
55)   void setStreamRecv(StreamRecv *pStreamRecv);
56) 
57)   /// update, i.e. (re-)read file and attach to new stream
58)   void update();
59) 
60)   /**
61)    * @brief get current frame
62)    * @return current frame (NULL for none)
63)    */
64)   stBlinkenFrame * getCurFrame() const;
65) 
66) protected:
67)   /// attach to stream
68)   void attach();
69) 
70)   /// detach from stream
71)   void detach();
72) 
73) protected:
74)   StreamRecv *m_pStreamRecv; ///< stream receiver to attach to input stream
75) }; // class InStreamFile
76) 
77) } // namespace Blinker
78) 

79) #endif // #ifndef BLINKER_INSTREAMFILE_H