OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RTC::PublisherBase Class Referenceabstract

Base class of Publisher. More...

#include <PublisherBase.h>

Inheritance diagram for RTC::PublisherBase:
Inheritance graph
[legend]

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.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~PublisherBase()

virtual RTC::PublisherBase::~PublisherBase ( )
virtualdefault

Destructor.

Member Function Documentation

◆ activate()

virtual DataPortStatus RTC::PublisherBase::activate ( )
pure virtual

◆ deactivate()

virtual DataPortStatus RTC::PublisherBase::deactivate ( )
pure virtual

deactivation

Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.

◆ init()

virtual DataPortStatus RTC::PublisherBase::init ( coil::Properties &  prop)
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.

Parameters
propConfiguration information

Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.

◆ isActive()

virtual bool RTC::PublisherBase::isActive ( )
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.

Returns
Result of state confirmation (Active state:true, Inactive state:false)

Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.

◆ release()

virtual void RTC::PublisherBase::release ( )
inlinevirtual

Release the Publisher.

Release this Publisher. When Publisher becomes unnecessary, this is invoked from PublisherFactory.

◆ setBuffer()

virtual DataPortStatus RTC::PublisherBase::setBuffer ( BufferBase< ByteData > *  buffer)
pure virtual

Setting buffer pointer.

◆ setConsumer()

virtual DataPortStatus RTC::PublisherBase::setConsumer ( InPortConsumer consumer)
pure virtual

Store InPort consumer.

Implemented in RTC::PublisherFlush, RTC::PublisherNew, and RTC::PublisherPeriodic.

◆ setListener()

virtual DataPortStatus RTC::PublisherBase::setListener ( ConnectorInfo info,
ConnectorListenersBase listeners 
)
pure virtual

Set the listener.

Implemented in RTC::PublisherNew, RTC::PublisherPeriodic, and RTC::PublisherFlush.

◆ write()

virtual DataPortStatus RTC::PublisherBase::write ( ByteDataStreamBase data,
std::chrono::nanoseconds  timeout 
)
pure virtual

The documentation for this class was generated from the following file: