pubThread.hpp

Go to the documentation of this file.

 
#ifndef CCF_CONTROL_PUB_THREAD_HPP_H_
#define CCF_CONTROL_PUB_THREAD_HPP_H_
 
#include "ifw/ccf/common/base.hpp"
#include "ifw/ccf/common/utilities.hpp"
#include "ifw/ccf/common/frameQueue.hpp"
#include "ifw/ccf/common/pubBase.hpp"
 
namespace ifw::ccf::control {
 
  class PubThread: public ifw::ccf::mptk::Thread, public ifw::ccf::Base {
  public:
 
    static void SetStatusAll(const ifw::ccf::PubStatus status);
 
    PubThread(const std::string& thread_name,
              ifw::ccf::mptk::MessageBus& message_bus,
              const double period = 0.1);
 
    virtual ~PubThread();
 
    void Initialise();
 
    virtual void UserLogic();
 
    void SetProcThrOutputQ(std::shared_ptr<ifw::ccf::common::FrameQueue>& queue);
 
    ifw::ccf::common::FrameQueue& GetProcThrOutputQ();
 
    void SetStatus(const ifw::ccf::PubStatus status);
 
    ifw::ccf::PubStatus GetStatus() const;
 
    void AddPublisher(ifw::ccf::common::PubBase& pub_obj);
 
    uint8_t NbOfPublishers() const;
 
    const ifw::ccf::common::PubBase& GetPublisher(const uint16_t nb) const;
 
    ifw::ccf::common::PubBase& GetPublisher();
 
    const std::list<ifw::ccf::common::PubBase*>& GetPublishers() const;
 
    void SetParentProcThreadName(const std::string& parent_proc_thread_name);
 
    const std::string& GetParentProcThreadName() const;
 
    ifw::ccf::common::FrameStatistics& GetFrameStat();
 
  protected:
 
  private:
    bool CheckMessageBus(bool& new_data_available,
                         bool& new_setup);
    void GetFrameHandleRef();
    void InvokePublishers();
    void ReleaseFrameHandle();
    void HandleNewSetup(ifw::ccf::Status& status,
                        std::string& diagnostics);
 
    std::string             m_parent_proc_thr_name;
 
    ifw::ccf::mptk::Message      m_cur_msg;   // Current thread message being handled.
 
    // Current data frame being handled. Should not be shared_ptr.
    ifw::ccf::common::DataFrame* m_cur_frame;
 
    // Used to avoid updating OLDB/PubSub unnecessary.
    ifw::ccf::PubStatus m_pub_thread_status;
 
    // TODO: Consider to allow only one publisher:
    // std::shared_ptr<ifw::ccf::common::PubBase> m_publisher;
    std::list<ifw::ccf::common::PubBase*> m_publishers;
 
    ProcThread* m_parent_proc_thr;
 
    // Map to find Data Publisher objects easily by means of the Thread ID.
    std::map<std::string, ifw::ccf::common::PubBase*> m_publisher_map;
 
    // Note: The queues are allocated and deleted by the ifw::ccf::control::application class.
    std::shared_ptr<ifw::ccf::common::FrameQueue> m_proc_thr_output_q;
 
    ifw::ccf::common::FrameStatistics m_frame_stat;
  };
 
}
 
#endif // CCF_CONTROL_PUB_THREAD_HPP_H_