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

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

#include <OutPort.h>

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

RTC::OutPortBase RTC::PortBase RTC::DataPortStatus

すべてのメンバ一覧

Public メソッド

 OutPort (const char *name, DataType &value)
 コンストラクタ
virtual ~OutPort (void)
 デストラクタ
virtual bool write (DataType &value)
 データ書き込み
bool write ()
 データ書き込み
bool operator<< (DataType &value)
 データ書き込み
bool read (DataType &value)
 データ読み出し
void setReadBlock (bool block)
 データ読み出し処理のブロックモードの設定
void setWriteBlock (bool block)
 データ書き込み処理のブロックモードの設定
void setReadTimeout (long int timeout)
 読み出し処理のタイムアウト時間の設定
void setWriteTimeout (long int timeout)
 書き込み処理のタイムアウト時間の設定
void setOnWrite (OnWrite< DataType > *on_write)
 OnWrite コールバックの設定
void setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert)
 OnWriteConvert コールバックの設定
void setOnOverflow (OnOverflow< DataType > *on_overflow)
 OnOverflow コールバックの設定
void setOnRead (OnRead< DataType > *on_read)
 OnRead コールバックの設定
void setOnReadConvert (OnReadConvert< DataType > *on_rconvert)
 OnReadConvert コールバックの設定
void setOnUnderflow (OnUnderflow< DataType > *on_underflow)
 OnUnderflow コールバックの設定
void setOnConnect (OnConnect *on_connect)
void setOnDisconnect (OnConnect *on_disconnect)
virtual void onConnect (const char *id, PublisherBase *publisher)
 Interface情報を公開する
virtual void onDisconnect (const char *id)

構成

struct  subscribe


説明

template<class DataType>
class RTC::OutPort< DataType >

OutPort テンプレートクラス

OutPort テンプレートクラス、テンプレートの引数として、OutPortが 扱うデータ型 DataType, OutPortのバッファ型 BufferType をとる。

から:
0.2.0

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

template<class DataType>
RTC::OutPort< DataType >::OutPort ( const char *  name,
DataType &  value 
) [inline]

コンストラクタ

コンストラクタ

引数:
name ポート名
value このポートにバインドされるデータ変数
length バッファ長(デフォルト値:8)

template<class DataType>
virtual RTC::OutPort< DataType >::~OutPort ( void   )  [inline, virtual]

デストラクタ

デストラクタ


関数

template<class DataType>
virtual bool RTC::OutPort< DataType >::write ( DataType &  value  )  [inline, virtual]

データ書き込み

ポートへデータを書き込む。

引数:
value 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)

template<class DataType>
bool RTC::OutPort< DataType >::write (  )  [inline]

データ書き込み

ポートへデータを書き込む。 バインドされた変数に設定された値をポートに書き込む。

戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)

template<class DataType>
bool RTC::OutPort< DataType >::operator<< ( DataType &  value  )  [inline]

データ書き込み

ポートへデータを書き込む。 設定された値をポートに書き込む。

引数:
value 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)

template<class DataType>
bool RTC::OutPort< DataType >::read ( DataType &  value  )  [inline]

データ読み出し

DataPort から値を読み出す

引数:
value 読み出したデータ
戻り値:
読み出し処理実行結果(読み出し成功:true、読み出し失敗:false)

template<class DataType>
void RTC::OutPort< DataType >::setReadBlock ( bool  block  )  [inline]

データ読み出し処理のブロックモードの設定

読み出し処理に対してブロックモードを設定する。 ブロックモードを指定した場合、読み出せるデータを受信するかタイムアウト が発生するまで、read() メソッドの呼びだしがブロックされる。

引数:
block ブロックモードフラグ

template<class DataType>
void RTC::OutPort< DataType >::setWriteBlock ( bool  block  )  [inline]

データ書き込み処理のブロックモードの設定

書き込み処理に対してブロックモードを設定する。 ブロックモードを指定した場合、バッファに書き込む領域ができるか タイムアウトが発生するまで write() メソッドの呼びだしがブロックされる。

引数:
block ブロックモードフラグ

template<class DataType>
void RTC::OutPort< DataType >::setReadTimeout ( long int  timeout  )  [inline]

読み出し処理のタイムアウト時間の設定

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

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

template<class DataType>
void RTC::OutPort< DataType >::setWriteTimeout ( long int  timeout  )  [inline]

書き込み処理のタイムアウト時間の設定

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

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

template<class DataType>
void RTC::OutPort< DataType >::setOnWrite ( OnWrite< DataType > *  on_write  )  [inline]

OnWrite コールバックの設定

データ書き込み直前に呼ばれる OnWrite コールバックファンクタを設定する。

引数:
on_write OnWrite コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnWriteConvert ( OnWriteConvert< DataType > *  on_wconvert  )  [inline]

OnWriteConvert コールバックの設定

データ書き込み時に呼ばれる OnWriteConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が書き込まれる。 このため書き込みデータのフィルタリングが可能となる。

引数:
on_wconvert OnWriteConvert コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnOverflow ( OnOverflow< DataType > *  on_overflow  )  [inline]

OnOverflow コールバックの設定

バッファフルによりデータ書き込みができない場合に呼び出される OnOverflow コールバックファンクタを設定する。

引数:
on_overflow OnOverflow コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnRead ( OnRead< DataType > *  on_read  )  [inline]

OnRead コールバックの設定

データ読み出し直前に呼び出される OnRead コールバックファンクタを設定 する。

引数:
on_read OnRead コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnReadConvert ( OnReadConvert< DataType > *  on_rconvert  )  [inline]

OnReadConvert コールバックの設定

データ読み出し時に呼ばれる OnReadConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が読み込まれる。 このため読み込みデータのフィルタリングが可能となる。

引数:
on_rconvert OnReadConvert コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnUnderflow ( OnUnderflow< DataType > *  on_underflow  )  [inline]

OnUnderflow コールバックの設定

バッファエンプティにより読み出せるデータがない場合に呼び出される コールバックファンクタ OnUnderflow を設定する。

引数:
on_underflow OnUnderflow コールバックファンクタ

template<class DataType>
void RTC::OutPort< DataType >::setOnConnect ( OnConnect on_connect  )  [inline]

template<class DataType>
void RTC::OutPort< DataType >::setOnDisconnect ( OnConnect on_disconnect  )  [inline]

template<class DataType>
virtual void RTC::OutPort< DataType >::onConnect ( const char *  id,
PublisherBase publisher 
) [inline, virtual]

Interface情報を公開する

Interface情報を公開する。

引数:
connector_profile Interface情報を書き込むコネクタプロファイル
Interface情報を取得する

コネクタプロファイルで与えられた情報から、インターフェース情報を 取得する。

引数:
connector_profile インターフェース情報を取得するコネクタ プロファイル
戻り値:
登録処理結果
登録されているInterface情報を解除する

接続を開場するために、登録済みのコネクタプロファイルを解除する。 取得する。

引数:
connector_profile インターフェース情報を解除するコネクタ プロファイル
戻り値:
登録処理結果

RTC::OutPortBaseを再定義しています。

template<class DataType>
virtual void RTC::OutPort< DataType >::onDisconnect ( const char *  id  )  [inline, virtual]

RTC::OutPortBaseを再定義しています。


OpenRTMに対してSun May 24 14:08:26 2009に生成されました。  doxygen 1.5.3