OpenRTM-aist 2.1.0
|
Base class of Publisher. More...
#include <PublisherBase.h>
Public Member Functions | |
virtual | ~PublisherBase ()=default |
Destructor. | |
virtual DataPortStatus | init (coil::Properties &prop)=0 |
Initializing configuration. | |
virtual DataPortStatus | setConsumer (InPortConsumer *consumer)=0 |
Store InPort consumer. | |
virtual DataPortStatus | setBuffer (BufferBase< ByteData > *buffer)=0 |
Setting buffer pointer. | |
virtual DataPortStatus | setListener (ConnectorInfo &info, ConnectorListenersBase *listeners)=0 |
Set the listener. | |
virtual DataPortStatus | write (ByteDataStreamBase *data, std::chrono::nanoseconds timeout)=0 |
Write data. | |
virtual bool | isActive ()=0 |
If publisher is active state. | |
virtual DataPortStatus | activate ()=0 |
activation | |
virtual DataPortStatus | deactivate ()=0 |
deactivation | |
virtual void | release () |
Release the Publisher. | |
Base class of Publisher.
This is a base class of Publisher*. This class manages data send timing. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.
This is a base class of Publisher*. This class manages data send timing. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.
This is a base class of Publisher*. This class manages data send timing. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.
|
virtualdefault |
Destructor.
|
pure virtual |
activation
Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.
|
pure virtual |
deactivation
Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.
|
pure virtual |
Initializing configuration.
This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.
prop | Configuration information |
Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.
|
pure virtual |
If publisher is active state.
A Publisher can be activated/deactivated synchronized with the data port. The active state and the non-active state are made transition by the "activate()" and the "deactivate()" functions respectively. This function confirms if the publisher is in active state.
Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.
|
inlinevirtual |
Release the Publisher.
Release this Publisher. When Publisher becomes unnecessary, this is invoked from PublisherFactory.
|
pure virtual |
Setting buffer pointer.
|
pure virtual |
Store InPort consumer.
Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.
|
pure virtual |
Set the listener.
Implemented in RTC::PublisherNew, RTC::PublisherPeriodic, and RTC::PublisherFlush.
|
pure virtual |
Write data.
Implemented in RTC::PublisherNew, RTC::PublisherPeriodic, and RTC::PublisherFlush.