ifw-ccf  2.0.0
comAdptRtms.hpp
Go to the documentation of this file.
1 
5 #ifndef CCF_PROTOCOLS_RTMS_LIB_COM_ADPT_HPP_H_
6 #define CCF_PROTOCOLS_RTMS_LIB_COM_ADPT_HPP_H_
7 
8 #include <stdint.h>
9 #include <vector>
10 #include <thread>
11 
15 
16 namespace ccf::protocols::rtms {
17 
18  constexpr auto RTMS_PROP_PORT = "Port";
19  constexpr auto RTMS_PROP_NET_IF = "NetworkInterface";
20  constexpr auto RTMS_PROP_WIDTH = "Width";
21  constexpr auto RTMS_PROP_HEIGHT = "Height";
22  constexpr auto RTMS_PROP_DATA_TYPE = "DataType";
23  constexpr auto RTMS_PROP_QUEUE_SIZE = "QueueSize";
24  constexpr auto RTMS_PROP_MAX_FRAME_RATE = "MaxFrameRate";
25 
30  public:
31 
33  // Constants
36  // @{
37  // @}
38 
39  ComAdptRtms();
40  virtual ~ComAdptRtms();
41 
42  virtual void InitialiseUser();
43 
44  virtual void CheckConnectionUser(bool& connected);
45 
46  virtual void CheckStatusUser(ccf::HwStatus& status,
47  std::string& message);
48  virtual void ConnectUser();
49 
50  virtual void DisconnectUser();
51 
52  virtual bool IsConnectedUser() const;
53 
54  virtual void ReadUser(const std::string& name,
55  core::utils::param::Parameter& par);
56 
57  virtual void ReceiveUser(ccf::common::DataFrame& frame,
58  bool& frame_received,
59  const double timeout,
60  bool& timed_out);
61 
62  virtual void ScanUser(std::vector<core::utils::param::Parameter>& pars);
63 
64  virtual void StartUser();
65 
66  virtual void StopUser();
67 
68  virtual void WriteUser(const core::utils::param::Parameter& par);
69 
70  virtual double GetTheoreticFrameRateUser();
71 
72  protected:
74  std::thread* m_receiver_thread;
75  };
76 
77  }
78 
79  #endif // CCF_PROTOCOLS_RTMS_LIB_COM_ADPT_HPP_H_
ccf::protocols::rtms::ComAdptRtms::ReadUser
virtual void ReadUser(const std::string &name, core::utils::param::Parameter &par)
Definition: comAdptRtms.cpp:103
ccf::protocols::rtms::RTMS_PROP_QUEUE_SIZE
constexpr auto RTMS_PROP_QUEUE_SIZE
Definition: comAdptRtms.hpp:23
ccf::tools::rtms2ccflib::RtmsCcfReceiver
The RtmsCcfReceiver struct receives RTMS packets and package these in ccf::common::DataFrame objects.
Definition: rtmsCcfReceiver.hpp:25
ccf::protocols::rtms::ComAdptRtms::~ComAdptRtms
virtual ~ComAdptRtms()
Definition: comAdptRtms.cpp:49
ccf::protocols::rtms::ComAdptRtms::CheckStatusUser
virtual void CheckStatusUser(ccf::HwStatus &status, std::string &message)
Definition: comAdptRtms.cpp:66
ccf::protocols::rtms::ComAdptRtms::WriteUser
virtual void WriteUser(const core::utils::param::Parameter &par)
Definition: comAdptRtms.cpp:142
ccf::protocols::rtms::RTMS_PROP_WIDTH
constexpr auto RTMS_PROP_WIDTH
Definition: comAdptRtms.hpp:20
ccf::HwStatus
HwStatus
HW status values.
Definition: base.hpp:196
ccf::protocols::rtms::ComAdptRtms::m_receiver_thread
std::thread * m_receiver_thread
Definition: comAdptRtms.hpp:74
ccf::protocols::rtms::ComAdptRtms::m_rtms_receiver
ccf::tools::rtms2ccflib::RtmsCcfReceiver * m_rtms_receiver
Definition: comAdptRtms.hpp:73
ccf::protocols::rtms::ComAdptRtms::StopUser
virtual void StopUser()
Definition: comAdptRtms.cpp:137
rtmsCcfReceiver.hpp
ccf::protocols::rtms::RTMS_PROP_PORT
constexpr auto RTMS_PROP_PORT
Definition: comAdptRtms.hpp:18
ccf::protocols::rtms::ComAdptRtms::StartUser
virtual void StartUser()
Definition: comAdptRtms.cpp:132
ccf::protocols::rtms::RTMS_PROP_MAX_FRAME_RATE
constexpr auto RTMS_PROP_MAX_FRAME_RATE
Definition: comAdptRtms.hpp:24
ccf::protocols::rtms::RTMS_PROP_DATA_TYPE
constexpr auto RTMS_PROP_DATA_TYPE
Definition: comAdptRtms.hpp:22
ccf::protocols::rtms::RTMS_PROP_NET_IF
constexpr auto RTMS_PROP_NET_IF
Definition: comAdptRtms.hpp:19
ccf::protocols::rtms::ComAdptRtms::InitialiseUser
virtual void InitialiseUser()
Definition: comAdptRtms.cpp:28
nameMapping.hpp
ccf::protocols::rtms::ComAdptRtms::ConnectUser
virtual void ConnectUser()
Definition: comAdptRtms.cpp:79
ccf::protocols::rtms::ComAdptRtms::ScanUser
virtual void ScanUser(std::vector< core::utils::param::Parameter > &pars)
Definition: comAdptRtms.cpp:127
ccf::protocols::rtms::ComAdptRtms::ReceiveUser
virtual void ReceiveUser(ccf::common::DataFrame &frame, bool &frame_received, const double timeout, bool &timed_out)
Definition: comAdptRtms.cpp:109
comAdptBase.hpp
ccf::protocols::rtms
CCF Communication Adapter based on the Rtms SDK.
Definition: comAdptRtms.cpp:17
ccf::protocols::rtms::ComAdptRtms
CCF Communication Adapter implementing RTMS communication.
Definition: comAdptRtms.hpp:29
ccf::protocols::rtms::ComAdptRtms::CheckConnectionUser
virtual void CheckConnectionUser(bool &connected)
Definition: comAdptRtms.cpp:60
ccf::protocols::rtms::RTMS_PROP_HEIGHT
constexpr auto RTMS_PROP_HEIGHT
Definition: comAdptRtms.hpp:21
ccf::protocols::rtms::ComAdptRtms::ComAdptRtms
ComAdptRtms()
Definition: comAdptRtms.cpp:19
ccf::common::DataFrame
Frame class used to store the data and metadata for one frames received from the camera.
Definition: dataFrame.hpp:17
ccf::protocols::rtms::ComAdptRtms::IsConnectedUser
virtual bool IsConnectedUser() const
Definition: comAdptRtms.cpp:73
ccf::protocols::rtms::ComAdptRtms::DisconnectUser
virtual void DisconnectUser()
Definition: comAdptRtms.cpp:92
ccf::common::ComAdptBase
Class to be used as parent for CCF Communication Adapters.
Definition: comAdptBase.hpp:31
ccf::protocols::rtms::ComAdptRtms::GetTheoreticFrameRateUser
virtual double GetTheoreticFrameRateUser()
Definition: comAdptRtms.cpp:148