OutPortConsumer.h

Go to the documentation of this file.

// -*- C++ -*-
#ifndef RTC_OUTPORTCONSUMER_H
#define RTC_OUTPORTCONSUMER_H
 
#include <coil/Factory.h>
#include <rtm/DataPortStatus.h>
#include <rtm/CdrBufferBase.h>
#include <rtm/SystemLogger.h>
 
// Why RtORB does not allow the following foward declaration?
#if !defined(ORB_IS_RTORB) && !defined(ORB_IS_ORBEXPRESS)
namespace SDOPackage
{
  class NVList;
} // namespace SDOPackage
#endif  // ORB_IS_RTORB
 
namespace coil
{
  class Properties;
} // namespace coil
 
namespace RTC
{
  class ConnectorListenersBase;
  class ConnectorInfo;
 
  class OutPortConsumer
  {
  public:
 
    virtual ~OutPortConsumer() = default;
 
    virtual void init(coil::Properties& prop) = 0;
 
    virtual void setBuffer(CdrBufferBase* buffer) = 0;
 
    virtual void setListener(ConnectorInfo& info,
                             ConnectorListenersBase* listeners) = 0;
 
    virtual DataPortStatus get(ByteData& data) = 0;
 
    virtual bool subscribeInterface(const SDOPackage::NVList& properties) = 0;
 
    virtual void unsubscribeInterface(const SDOPackage::NVList& properties) = 0;
 
  protected:
 
    struct subscribe
    {
      explicit subscribe(const SDOPackage::NVList& prop) : m_prop(prop) {}
      void operator()(OutPortConsumer* consumer)
      {
        consumer->subscribeInterface(m_prop);
      }
      const SDOPackage::NVList& m_prop;
    };
 
    struct unsubscribe
    {
      explicit unsubscribe(const SDOPackage::NVList& prop) : m_prop(prop) {}
      void operator()(OutPortConsumer* consumer)
      {
        consumer->unsubscribeInterface(m_prop);
      }
      const SDOPackage::NVList& m_prop;
    };
  };
 
  using OutPortConsumerFactory = ::coil::GlobalFactory<OutPortConsumer>;
} // namespace RTC
 
 
#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
EXTERN template class DLL_PLUGIN coil::GlobalFactory<RTC::OutPortConsumer>;
#elif defined(__GNUC__)
EXTERN template class coil::GlobalFactory<RTC::OutPortConsumer>;
#endif
 
#endif  // RTC_OUTPORTCONSUMER_H