Blinker

src/noarch/Output.h   1) /* Blinker

src/common/Output.h   2)    Copyright 2011-2019 Stefan Schuermans <stefan@blinkenarea.org>

src/noarch/Output.h   3)    Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html
src/noarch/Output.h   4)    a blinkenarea.org project */
src/noarch/Output.h   5) 

src/noarch/Output.h   6) #ifndef BLINKER_OUTPUT_H
src/noarch/Output.h   7) #define BLINKER_OUTPUT_H

src/noarch/Output.h   8) 
src/noarch/Output.h   9) #include <string>
src/noarch/Output.h  10) 
src/noarch/Output.h  11) #include <BlinkenLib/BlinkenFrame.h>
src/noarch/Output.h  12) 
src/noarch/Output.h  13) #include "Device.h"
src/noarch/Output.h  14) #include "Directory.h"
src/noarch/Output.h  15) #include "File.h"
src/noarch/Output.h  16) #include "InStreamFile.h"

src/noarch/Output.h  17) #include "Mgrs.h"

src/noarch/Output.h  18) #include "Module.h"
src/noarch/Output.h  19) #include "NameFile.h"
src/noarch/Output.h  20) #include "Protocol.h"
src/noarch/Output.h  21) #include "ProtocolFile.h"
src/noarch/Output.h  22) #include "SerCfgFile.h"
src/noarch/Output.h  23) #include "StreamRecv.h"

src/noarch/Output.h  24) #include "Time.h"

src/noarch/Output.h  25) #include "TimeCallee.h"
src/noarch/Output.h  26) 
src/noarch/Output.h  27) namespace Blinker {
src/noarch/Output.h  28) 
src/noarch/Output.h  29) /// output of a stream to a device
src/noarch/Output.h  30) class Output: public Module, public StreamRecv, public TimeCallee
src/noarch/Output.h  31) {
src/noarch/Output.h  32) public:
src/noarch/Output.h  33)   /**
src/noarch/Output.h  34)    * @brief constructor

src/noarch/Output.h  35)    * @param[in] name module name

src/noarch/Output.h  36)    * @param[in] mgrs managers

src/noarch/Output.h  37)    * @param[in] dirBase base directory
src/noarch/Output.h  38)    */

src/noarch/Output.h  39)   Output(const std::string &name, Mgrs &mgrs, const Directory &dirBase);

src/noarch/Output.h  40) 
src/noarch/Output.h  41)   /// virtual destructor
src/noarch/Output.h  42)   virtual ~Output();
src/noarch/Output.h  43) 
src/noarch/Output.h  44) private:
src/noarch/Output.h  45)   /// copy constructor disabled
src/noarch/Output.h  46)   Output(const Output &that);
src/noarch/Output.h  47) 
src/noarch/Output.h  48)   /// assignment operator disabled
src/noarch/Output.h  49)   const Output & operator=(const Output &that);
src/noarch/Output.h  50) 
src/noarch/Output.h  51) public:
src/noarch/Output.h  52)   /// check for update of configuration
src/noarch/Output.h  53)   virtual void updateConfig();
src/noarch/Output.h  54) 
src/noarch/Output.h  55)   /**
src/noarch/Output.h  56)    * @brief set current frame
src/noarch/Output.h  57)    * @param[in] stream stream name
src/noarch/Output.h  58)    * @param[in] pFrame current frame (NULL for none)
src/noarch/Output.h  59)    */
src/noarch/Output.h  60)   virtual void setFrame(const std::string &stream, stBlinkenFrame *pFrame);
src/noarch/Output.h  61) 
src/noarch/Output.h  62)   /// callback when requested time reached
src/noarch/Output.h  63)   virtual void timeCall();
src/noarch/Output.h  64) 
src/noarch/Output.h  65) protected:
src/noarch/Output.h  66)   /// (re-)read protocol
src/noarch/Output.h  67)   void readProto();
src/noarch/Output.h  68) 
src/noarch/Output.h  69)   /// open device
src/noarch/Output.h  70)   void openDevice();
src/noarch/Output.h  71) 
src/noarch/Output.h  72)   /// close device
src/noarch/Output.h  73)   void closeDevice();
src/noarch/Output.h  74) 
src/noarch/Output.h  75)   /// output current frame to device
src/noarch/Output.h  76)   void outputFrame();
src/noarch/Output.h  77) 

src/noarch/Output.h  78)   /**
src/noarch/Output.h  79)    * @brief output frame data to device
src/noarch/Output.h  80)    * @param[in] data data of one frame to output to device
src/noarch/Output.h  81)    */
src/noarch/Output.h  82)   void outputFrameData(const std::string &data);
src/noarch/Output.h  83) 

src/noarch/Output.h  84)   /// write data in output buffer to device
src/noarch/Output.h  85)   void outputBufferedData();
src/noarch/Output.h  86) 
src/noarch/Output.h  87)   /// update time callback request
src/noarch/Output.h  88)   void updateTimeCallback();
src/noarch/Output.h  89) 

src/noarch/Output.h  90) protected:
src/noarch/Output.h  91)   InStreamFile m_fileInStream; ///< input stream name file
src/noarch/Output.h  92)   ProtocolFile m_fileProtocol; ///< protocol file

src/noarch/Output.h  93)   NameFile     m_fileDevice;   ///< name file containing name of device

src/noarch/Output.h  94)   SerCfgFile   m_fileSerCfg;   ///< serial port configuration file
src/noarch/Output.h  95)   Device       *m_pDevice;     ///< device to output to

src/noarch/Output.h  96)   std::string  m_buffer;       ///< buffered data still to be output to device

src/noarch/Output.h  97)   bool         m_dropped;      ///< if the last frame has been dropped

src/noarch/Output.h  98) }; // class Output
src/noarch/Output.h  99) 
src/noarch/Output.h 100) } // namespace Blinker
src/noarch/Output.h 101) 

src/noarch/Output.h 102) #endif // #ifndef BLINKER_OUTPUT_H