Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTC::OutPort< DataType, Buffer > Class Template Reference

#include <OutPort.h>

Inheritance diagram for RTC::OutPort< DataType, Buffer >:

RTC::OutPortBase List of all members.

Public Member Functions

 OutPort (const char *name, DataType &value, long int length=8)
 Constructor.
virtual ~OutPort ()
virtual bool write (const DataType &value)
 Write data.
bool write ()
bool operator<< (DataType &value)
bool read (DataType &value)
 Read data.
void setReadBlock (bool block)
 Set read() block mode.
void setWriteBlock (bool block)
 Set read() block mode.
void setReadTimeout (long int timeout)
 Set read() timeout.
void setWriteTimeout (long int timeout)
 Set write() timeout.
void setOnWrite (OnWrite< DataType > *on_write)
 Set OnWrite callback.
void setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert)
 Set OnWriteConvert callback.
void setOnOverflow (OnOverflow< DataType > *on_overflow)
 Set OnOverflow callback.
void setOnRead (OnRead< DataType > *on_read)
 Set OnRead callback.
void setOnReadConvert (OnReadConvert< DataType > *on_rconvert)
 Set OnReadConvert callback.
void setOnUnderflow (OnUnderflow< DataType > *on_underflow)
 Set OnUnderflow callback.
const char * name ()
 OutPort's name.
void attach (const char *id, PublisherBase *publisher)
 Attach a publisher.
void attach_front (const char *id, PublisherBase *publisher)
 Attach a publisher.
void attach_back (const char *id, PublisherBase *publisher)
 Attach a publisher.
PublisherBasedetach (const char *id)
 Detach a publisher.
void notify ()
 Notify data update.

Protected Attributes

std::string m_name
std::vector< Publisher * > m_publishers
 Publisher list.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
class RTC::OutPort< DataType, Buffer >


Constructor & Destructor Documentation

template<class DataType, template< class DataType > class Buffer = RingBuffer>
RTC::OutPort< DataType, Buffer >::OutPort const char *  name,
DataType &  value,
long int  length = 8
[inline]
 

Constructor.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
virtual RTC::OutPort< DataType, Buffer >::~OutPort  )  [inline, virtual]
 


Member Function Documentation

void RTC::OutPortBase::attach const char *  id,
PublisherBase publisher
[inherited]
 

Attach a publisher.

Attach a publisher to observe OutPort.

void RTC::OutPortBase::attach_back const char *  id,
PublisherBase publisher
[inherited]
 

Attach a publisher.

Attach a publisher to the taile of the Publisher list.

void RTC::OutPortBase::attach_front const char *  id,
PublisherBase publisher
[inherited]
 

Attach a publisher.

Attach a publisher to the head of the Publisher list.

PublisherBase* RTC::OutPortBase::detach const char *  id  )  [inherited]
 

Detach a publisher.

Detach a publisher to observe OutPort.

const char* RTC::OutPortBase::name  )  [inline, inherited]
 

OutPort's name.

This operation returns OutPort's name

void RTC::OutPortBase::notify  )  [inherited]
 

Notify data update.

This operation notify data update to Publishers

template<class DataType, template< class DataType > class Buffer = RingBuffer>
bool RTC::OutPort< DataType, Buffer >::operator<< DataType &  value  )  [inline]
 

template<class DataType, template< class DataType > class Buffer = RingBuffer>
bool RTC::OutPort< DataType, Buffer >::read DataType &  value  )  [inline]
 

Read data.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnOverflow OnOverflow< DataType > *  on_overflow  )  [inline]
 

Set OnOverflow callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnRead OnRead< DataType > *  on_read  )  [inline]
 

Set OnRead callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnReadConvert OnReadConvert< DataType > *  on_rconvert  )  [inline]
 

Set OnReadConvert callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnUnderflow OnUnderflow< DataType > *  on_underflow  )  [inline]
 

Set OnUnderflow callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnWrite OnWrite< DataType > *  on_write  )  [inline]
 

Set OnWrite callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setOnWriteConvert OnWriteConvert< DataType > *  on_wconvert  )  [inline]
 

Set OnWriteConvert callback.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setReadBlock bool  block  )  [inline]
 

Set read() block mode.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setReadTimeout long int  timeout  )  [inline]
 

Set read() timeout.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setWriteBlock bool  block  )  [inline]
 

Set read() block mode.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::OutPort< DataType, Buffer >::setWriteTimeout long int  timeout  )  [inline]
 

Set write() timeout.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
bool RTC::OutPort< DataType, Buffer >::write  )  [inline]
 

template<class DataType, template< class DataType > class Buffer = RingBuffer>
virtual bool RTC::OutPort< DataType, Buffer >::write const DataType &  value  )  [inline, virtual]
 

Write data.


Member Data Documentation

std::string RTC::OutPortBase::m_name [protected, inherited]
 

std::vector<Publisher*> RTC::OutPortBase::m_publishers [protected, inherited]
 

Publisher list.


The documentation for this class was generated from the following file:
Generated on Fri Oct 5 05:16:04 2007 for OpenRTM by  doxygen 1.4.1