RTC::PublisherBase Class Reference

Base class of Publisher. More...

#include <PublisherBase.h>

Inheritance diagram for RTC::PublisherBase:

RTC::DataPortStatus RTC::PublisherFlush RTC::PublisherNew RTC::PublisherPeriodic

List of all members.

Public Member Functions

virtual DATAPORTSTATUS_ENUM ~PublisherBase (void)
 Destructor.
virtual ReturnCode init (coil::Properties &prop)=0
 Initializing configuration.
virtual ReturnCode setConsumer (InPortConsumer *consumer)=0
 Store InPort consumer.
virtual ReturnCode setBuffer (BufferBase< cdrMemoryStream > *buffer)=0
 Setting buffer pointer.
virtual ReturnCode setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0
 Set the listener.
virtual ReturnCode write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)=0
 Write data.
virtual bool isActive ()=0
 Confirm to activate.
virtual ReturnCode activate ()=0
 activation
virtual ReturnCode 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.


Constructor & Destructor Documentation

virtual DATAPORTSTATUS_ENUM RTC::PublisherBase::~PublisherBase ( void   )  [inline, virtual]

Destructor.


Member Function Documentation

virtual ReturnCode 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:
prop Configuration information

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

virtual ReturnCode RTC::PublisherBase::setConsumer ( InPortConsumer consumer  )  [pure virtual]

Store InPort consumer.

Parameters:
consumer InPort consumer

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

virtual ReturnCode RTC::PublisherBase::setBuffer ( BufferBase< cdrMemoryStream > *  buffer  )  [pure virtual]

Setting buffer pointer.

Parameters:
buffer CDR buffer

virtual ReturnCode RTC::PublisherBase::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [pure virtual]

Set the listener.

Parameters:
info ConnectorInfo
listeners ConnectorListeners

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

virtual ReturnCode RTC::PublisherBase::write ( const cdrMemoryStream &  data,
unsigned long  sec,
unsigned long  usec 
) [pure virtual]

Write data.

Parameters:
data Data
sec Timeout period
nsec Timeout period

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

virtual bool RTC::PublisherBase::isActive (  )  [pure virtual]

Confirm to activate.

Confirm that has been activated.

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

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

virtual ReturnCode RTC::PublisherBase::activate (  )  [pure virtual]

virtual ReturnCode RTC::PublisherBase::deactivate (  )  [pure virtual]

deactivation

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

virtual void RTC::PublisherBase::release (  )  [inline, virtual]

Release the Publisher.

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


Generated on Thu Jan 28 13:25:36 2010 for OpenRTM by  doxygen 1.5.5