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

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

#include <InPort.h>

List of all members.

Public Member Functions

 InPort (const char *name, DataType &value, int bufsize=64, bool read_block=false, bool write_block=false, int read_timeout=0, int write_timeout=0)
 A constructor.
virtual ~InPort ()
 A destructor.
virtual const char * name ()
bool write (const DataType &value)
DataType read ()
 [CORBA interface] Put data on InPort
virtual void init (DataType &value)
 Initialize ring buffer value of InPort.
void update ()
 Read into bound T-type data from current InPort.
void operator>> (DataType &rhs)
 Read from InPort buffer to type-T variable.
void operator<< (DataType &value)
void setOnWrite (OnWrite< DataType > *on_write)
 Get number of new data to be read. Get new data to be read. Get new data to be read. Get new data to be read.
void setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert)
void setOnRead (OnRead< DataType > *on_read)
void setOnReadConvert (OnReadConvert< DataType > *on_rconvert)
void setOnOverflow (OnOverflow< DataType > *on_overflow)
void setOnUnderflow (OnUnderflow< DataType > *on_underflow)

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


Constructor & Destructor Documentation

template<class DataType, template< class DataType > class Buffer = RingBuffer>
RTC::InPort< DataType, Buffer >::InPort const char *  name,
DataType &  value,
int  bufsize = 64,
bool  read_block = false,
bool  write_block = false,
int  read_timeout = 0,
int  write_timeout = 0
[inline]
 

A constructor.

Setting channel name and registering channel value.

Parameters:
name A name of the InPort. This name is referred by InPortBase::name().
value A channel value related with the channel.
bufsize Buffer length of internal ring buffer of InPort

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

A destructor.


Member Function Documentation

template<class DataType, template< class DataType > class Buffer = RingBuffer>
virtual void RTC::InPort< DataType, Buffer >::init DataType &  value  )  [inline, virtual]
 

Initialize ring buffer value of InPort.

template<class DataType, template< class DataType > class Buffer = RingBuffer>
virtual const char* RTC::InPort< DataType, Buffer >::name  )  [inline, virtual]
 

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

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::InPort< DataType, Buffer >::operator>> DataType &  rhs  )  [inline]
 

Read from InPort buffer to type-T variable.

Parameters:
rhs type-T variable which is wrote from InPort buffer

template<class DataType, template< class DataType > class Buffer = RingBuffer>
DataType RTC::InPort< DataType, Buffer >::read  )  [inline]
 

[CORBA interface] Put data on InPort

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

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

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

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

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

Get number of new data to be read. Get new data to be read. Get new data to be read. Get new data to be read.

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

template<class DataType, template< class DataType > class Buffer = RingBuffer>
void RTC::InPort< DataType, Buffer >::update  )  [inline]
 

Read into bound T-type data from current InPort.

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


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