RTC::PublisherFlush Class Reference

PublisherFlush class. More...

#include <PublisherFlush.h>

Inheritance diagram for RTC::PublisherFlush:

RTC::PublisherBase RTC::DataPortStatus

List of all members.

Public Types

typedef coil::Mutex Mutex
typedef
coil::Condition
< Mutex
Condition
typedef coil::Guard
< coil::Mutex > 
Guard

Public Member Functions

DATAPORTSTATUS_ENUM PublisherFlush ()
 Constructor.
virtual ~PublisherFlush (void)
 Destructor.
virtual ReturnCode init (coil::Properties &prop)
 initialization
virtual ReturnCode setConsumer (InPortConsumer *consumer)
virtual ReturnCode setBuffer (CdrBufferBase *buffer)
virtual ReturnCode write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)
virtual bool isActive ()
virtual ReturnCode activate ()
virtual ReturnCode deactivate ()


Detailed Description

PublisherFlush class.

This is a Publisher class of Flush type. This class sends unsend data that has been stored in the buffer. This executes Consumer that waits for the data send timing in the same thread as its send side.


Member Typedef Documentation

typedef coil::Mutex RTC::PublisherFlush::Mutex

typedef coil::Condition<Mutex> RTC::PublisherFlush::Condition

typedef coil::Guard<coil::Mutex> RTC::PublisherFlush::Guard


Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::PublisherFlush::PublisherFlush (  ) 

Constructor.

Consrtuctor.

Parameters:
consumer Consumer to wait for the data sending
property Property object that have been set the control information of this Publisher

virtual RTC::PublisherFlush::~PublisherFlush ( void   )  [virtual]

Destructor.

Destructor This is invoked by PublisherFactory when this Publisher is destoroyed.


Member Function Documentation

virtual ReturnCode RTC::PublisherFlush::init ( coil::Properties &  prop  )  [virtual]

initialization

Implements RTC::PublisherBase.

virtual ReturnCode RTC::PublisherFlush::setConsumer ( InPortConsumer consumer  )  [virtual]

Implements RTC::PublisherBase.

virtual ReturnCode RTC::PublisherFlush::setBuffer ( CdrBufferBase buffer  )  [virtual]

Implements RTC::PublisherBase.

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

Implements RTC::PublisherBase.

virtual bool RTC::PublisherFlush::isActive (  )  [virtual]

Implements RTC::PublisherBase.

virtual ReturnCode RTC::PublisherFlush::activate (  )  [virtual]

Implements RTC::PublisherBase.

virtual ReturnCode RTC::PublisherFlush::deactivate (  )  [virtual]

Implements RTC::PublisherBase.


Generated on Sun May 24 14:08:46 2009 for OpenRTM by  doxygen 1.5.3