channelfilterbase.hpp

#ifndef DDF_CHANNELFILTERBASE_HPP
#define DDF_CHANNELFILTERBASE_HPP

#include <deque>
#include <iostream>
#include <fstream>

#include "commbase.hpp"
#include "infocontainer.hpp"
#include "predictenginebase.hpp"

namespace jafar
{ 
  namespace ddf
  {

    class ChannelFilterBase
    {
      typedef enum {EVENT_OUT, EVENT_SYNC, EVENT_NOSYNC} EVENT;
   
      CommBase             *m_comm;          // communication channel (the channel filter is in charge of deleting the communication object)
      InfoContainer        m_info_ij;        // common information between node i and j
      InfoContainer        m_new_ji;         // new information that node i does not yet have (that comes from node j)
      InfoContainer        m_pred_j;         // Yj(hori, hori-aj)... (see equation 17)
      PredictionEngineBase *m_pred_engine;   // prediction engine for synchronization to the next time horizon
      unsigned short       m_link_with_node; // tells with which node it is connected to
      unsigned short       m_belongs_to_node;
      time                 m_time_orig;      // only for logging purpose
      bool                 m_do_log;         // if true then log
      std::ofstream        m_dump_file;      // logfile

      void LogHeader();
      void DumpState(EVENT const& event, InfoContainer const& send_rec);
   
    public:

      ChannelFilterBase(unsigned short sv_size, unsigned short belongs_to_node, unsigned short link_with, CommBase *comm,
                    PredictionEngineBase *pred_engine, InfoContainer const& info_init);

      virtual ~ChannelFilterBase();

      // Set/get functions
      unsigned short GetLinkWithNode() const { return m_link_with_node; }
      InfoContainer const& GetNewInfo() const { return m_new_ji; }
      void SetCommonInfoTime(time const& t) { m_info_ij.SetTime(t); }
      
      void SetNow(time const& now) { m_time_orig = now; }
      bool Sync_Ok() const { return m_comm->Sync_Ok(); }

      void ResetJustReceived() { m_comm->ResetJustReceived(); }

      bool HasJustReceivedInfo() const { return m_comm->HasJustReceivedInfo(); }

      void SetLog(bool log) { if(!m_do_log && log) InitLog(); m_do_log = log; }

      // Main functions
      void  OutputInfoToOtherNode(InfoContainer const& to_j);

      bool Sync(time const& horizon);
      void PrintPredModel() { m_pred_engine->PrintModel(); }

      // Other
      void CloseLogFile();
   
    private:
      void InitLog();
    };


  } // namespace ddf
} // namespace jafar
#endif