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>

// Why RtORB does not allow the following foward declaration?
#if !defined(ORB_IS_RTORB) && !defined(ORB_IS_ORBEXPRESS)
namespace SDOPackage
{
  class NVList;
};
#endif // ORB_IS_RTORB

namespace coil
{
  class Properties;
};

namespace RTC
{
  class ConnectorListeners;
  class ConnectorInfo;

  class OutPortConsumer
    : public DataPortStatus
  {
  public:
    DATAPORTSTATUS_ENUM
    
    virtual ~OutPortConsumer(void){};

    virtual void init(coil::Properties& prop) = 0;

    virtual void setBuffer(CdrBufferBase* buffer) = 0;

    virtual void setListener(ConnectorInfo& info,
                             ConnectorListeners* listeners) = 0;

    virtual ReturnCode get(cdrMemoryStream& data) = 0;

    virtual bool subscribeInterface(const SDOPackage::NVList& properties) = 0;
    
    virtual void unsubscribeInterface(const SDOPackage::NVList& properties) = 0;

  protected:
    mutable Logger rtclog;

    struct subscribe
    {
      subscribe(const SDOPackage::NVList& prop) : m_prop(prop) {}
      void operator()(OutPortConsumer* consumer)
      {
        consumer->subscribeInterface(m_prop);
      }
      const SDOPackage::NVList& m_prop;
    };
    
    struct unsubscribe
    {
      unsubscribe(const SDOPackage::NVList& prop) : m_prop(prop) {}
      void operator()(OutPortConsumer* consumer)
      {
        consumer->unsubscribeInterface(m_prop);
      }
      const SDOPackage::NVList& m_prop;
    };
  };

  typedef ::coil::GlobalFactory<OutPortConsumer> OutPortConsumerFactory;

#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
  EXTERN template class DLL_PLUGIN ::coil::GlobalFactory<OutPortConsumer>;
#endif
};     // namespace RTC

#ifdef __GNUC__
extern template class coil::Singleton<coil::GlobalFactory<RTC::OutPortConsumer> >;
#endif

#endif // RTC_OUTPORTCONSUMER_H