OpenRTM-aist
2.1.0
Toggle main menu visibility
Loading...
Searching...
No Matches
PublisherBase.h
Go to the documentation of this file.
1
// -*- C++ -*-
19
20
#ifndef RTC_PUBLISHERBASE_H
21
#define RTC_PUBLISHERBASE_H
22
23
#include <coil/Properties.h>
24
#include <coil/Factory.h>
25
#include <
rtm/RTC.h
>
26
#include <
rtm/CdrBufferBase.h
>
27
#include <
rtm/DataPortStatus.h
>
28
#include <
rtm/ByteDataStreamBase.h
>
29
30
31
namespace
coil
32
{
33
class
Properties
;
34
}
// namespace coil
35
namespace
RTC
36
{
37
class
InPortConsumer
;
38
class
ConnectorListenersBase
;
39
class
ConnectorInfo
;
40
65
class
PublisherBase
66
{
67
public
:
79
virtual
~PublisherBase
() =
default
;
80
108
virtual
DataPortStatus
init
(coil::Properties& prop) = 0;
109
135
virtual
DataPortStatus
setConsumer
(
InPortConsumer
* consumer) = 0;
136
162
virtual
DataPortStatus
setBuffer
(
BufferBase<ByteData>
* buffer) = 0;
163
197
virtual
DataPortStatus
setListener
(
ConnectorInfo
& info,
198
ConnectorListenersBase
* listeners) = 0;
199
254
virtual
DataPortStatus
write
(
ByteDataStreamBase
* data,
255
std::chrono::nanoseconds timeout) = 0;
256
284
virtual
bool
isActive
() = 0;
285
311
virtual
DataPortStatus
activate
() = 0;
312
338
virtual
DataPortStatus
deactivate
() = 0;
339
358
virtual
void
release
(){}
359
};
360
361
using
PublisherFactory
= coil::GlobalFactory<PublisherBase>;
362
}
// namespace RTC
363
364
#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
365
EXTERN
template
class
DLL_PLUGIN coil::GlobalFactory<RTC::PublisherBase>;
366
#elif defined(__GNUC__)
367
EXTERN
template
class
coil::GlobalFactory<RTC::PublisherBase>;
368
#endif
369
370
#endif
// RTC_PUBLISHERBASE_H
ByteDataStreamBase.h
Data Stream Buffer Base class.
CdrBufferBase.h
DataPortStatus.h
DataPortStatus class.
RTC.h
RTComponent header.
RTC::BufferBase
BufferBase abstract class.
Definition
BufferBase.h:106
RTC::ByteDataStreamBase
Definition
ByteDataStreamBase.h:63
RTC::ConnectorInfo
ConnectorInfo class.
Definition
ConnectorBase.h:50
RTC::ConnectorListenersBase
Definition
ConnectorListener.h:1354
RTC::InPortConsumer
InPortConsumer abstract class.
Definition
InPortConsumer.h:78
RTC::PublisherBase
Base class of Publisher.
Definition
PublisherBase.h:66
RTC::PublisherBase::~PublisherBase
virtual ~PublisherBase()=default
Destructor.
RTC::PublisherBase::deactivate
virtual DataPortStatus deactivate()=0
deactivation
RTC::PublisherBase::setBuffer
virtual DataPortStatus setBuffer(BufferBase< ByteData > *buffer)=0
Setting buffer pointer.
RTC::PublisherBase::activate
virtual DataPortStatus activate()=0
activation
RTC::PublisherBase::release
virtual void release()
Release the Publisher.
Definition
PublisherBase.h:358
RTC::PublisherBase::write
virtual DataPortStatus write(ByteDataStreamBase *data, std::chrono::nanoseconds timeout)=0
Write data.
RTC::PublisherBase::setListener
virtual DataPortStatus setListener(ConnectorInfo &info, ConnectorListenersBase *listeners)=0
Set the listener.
RTC::PublisherBase::isActive
virtual bool isActive()=0
If publisher is active state.
RTC::PublisherBase::setConsumer
virtual DataPortStatus setConsumer(InPortConsumer *consumer)=0
Store InPort consumer.
RTC::PublisherBase::init
virtual DataPortStatus init(coil::Properties &prop)=0
Initializing configuration.
RTC
RT-Component.
RTC::PublisherFactory
coil::GlobalFactory< PublisherBase > PublisherFactory
Definition
PublisherBase.h:361
RTC::Properties
coil::Properties Properties
Definition
RTC.h:72
RTC::DataPortStatus
DataPortStatus
DataPortStatus return codes.
Definition
DataPortStatus.h:114
coil
Definition
DefaultPeriodicTask.h:24
Generated by
1.17.0