メインページ | ネームスペース一覧 | クラス階層 | 構成 | Directories | ファイル一覧 | ネームスペースメンバ | 構成メンバ | ファイルメンバ

クラス テンプレート RTC::OutPort< DataType, Buffer >

OutPort テンプレートクラス. [詳細]

#include <OutPort.h>

RTC::OutPort< DataType, Buffer >に対する継承グラフ

RTC::OutPortBase すべてのメンバ一覧

Public メソッド

 OutPort (const char *name, DataType &value, long int length=8)
 OutPort<DataType, BufferType> クラスのコンストラクタ.
virtual ~OutPort ()
virtual bool write (const DataType &value)
 データ書き込み
bool write ()
bool operator<< (DataType &value)
bool read (DataType &value)
 データ読み出し
void setReadBlock (bool block)
 read() のブロック・非ブロックモードのセット
void setWriteBlock (bool block)
 write() のブロック・非ブロックモードのセット
void setReadTimeout (long int timeout)
 read() のタイムアウト時間の設定
void setWriteTimeout (long int timeout)
 write() のタイムアウト時間の設定
void setOnWrite (OnWrite< DataType > *on_write)
 OutWrite コールバックの設定.
void setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert)
 OutWriteConvert コールバックの設定.
void setOnOverflow (OnOverflow< DataType > *on_overflow)
 OutOverflow コールバックの設定.
void setOnRead (OnRead< DataType > *on_read)
 OutRead コールバックの設定.
void setOnReadConvert (OnReadConvert< DataType > *on_rconvert)
 OutReadConvert コールバックの設定.
void setOnUnderflow (OnUnderflow< DataType > *on_underflow)
 OutUnderflow コールバックの設定.
const char * name ()
 OutPortの名前.
void attach (const char *id, PublisherBase *publisher)
 Publisherの追加.
void attach_front (const char *id, PublisherBase *publisher)
 Publisherの追加.
void attach_back (const char *id, PublisherBase *publisher)
 Publisherの追加.
PublisherBasedetach (const char *id)
 Publisherの削除.
void notify ()
 更新の通知

Protected 変数

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 >

OutPort テンプレートクラス.

OutPort テンプレートクラス、テンプレートの引数として、OutPortが 扱うデータ型 DataType, OutPortのバッファ型 BufferType をとる。 OutPort<> クラスは、ミドルウエア側のインターフェースとして


コンストラクタとデストラクタ

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

OutPort<DataType, BufferType> クラスのコンストラクタ.

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


関数

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

Publisherの追加.

Publisherを追加する。

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

Publisherの追加.

Publisherをリストの最後尾に追加する。

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

Publisherの追加.

Publisherをリストの先頭に追加する。

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

Publisherの削除.

Publisherを削除する。

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

OutPortの名前.

OutPortの名前を返す。

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

更新の通知

Publisherにデータの更新を通知する。

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]
 

データ読み出し

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

OutOverflow コールバックの設定.

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

OutRead コールバックの設定.

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

OutReadConvert コールバックの設定.

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

OutUnderflow コールバックの設定.

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

OutWrite コールバックの設定.

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

OutWriteConvert コールバックの設定.

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

read() のブロック・非ブロックモードのセット

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

read() のタイムアウト時間の設定

read() のタイムアウト時間を usec で設定する。 read() はブロックモードでなければならない。

引数:
timeout タイムアウト時間 [usec]

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

write() のブロック・非ブロックモードのセット

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

write() のタイムアウト時間の設定

write() のタイムアウト時間を usec で設定する。 write() はブロックモードでなければならない。

引数:
timeout タイムアウト時間 [usec]

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]
 

データ書き込み


変数

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

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

Publisher list.


このクラスの説明は次のファイルから生成されました:
OpenRTMに対してFri Oct 5 05:15:02 2007に生成されました。  doxygen 1.4.1