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

72) #endif // #ifndef BLINKER_INSTREAMFILE_H