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

クラス InPort

すべてのメンバ一覧

Public メソッド

 __init__ (name, value, buffer_, read_block=False, write_block=False, read_timeout=0, write_timeout=0)
 InPort クラスコンストラクタ.
 __del__ ()
 InPortクラスデストラクタ.
 isNew ()
 name ()
 write (value)
 DataPort に値を書き込む.
 read ()
 DataPort から値を読み出す.
 init (value)
 InPort 内のリングバッファの値を初期化.
 update ()
 バインドされた変数self._valueに InPort バッファの最新値を読み込む
 setOnWrite (on_write)
 InPort バッファにデータ入力時のコールバックの設定.
 setOnWriteConvert (on_wconvert)
 setOnRead (on_read)
 setOnReadConvert (on_rconvert)
 setOnOverflow (on_overflow)
 setOnUnderflow (on_underflow)
 getPortDataType ()
 データ取得のためのメソッド データの型名を取得するため、InPortCorbaProviderから呼ばれる。 added by kurihara

関数

InPort::__del__  ) 
 

InPortクラスデストラクタ.

InPortクラスのデストラクタ。

InPort::__init__ name  ,
value  ,
buffer_  ,
read_block  = False,
write_block  = False,
read_timeout  = 0,
write_timeout  = 0
 

InPort クラスコンストラクタ.

InPortクラスのコンストラクタ。

引数:
name InPort 名。InPortBase:name() により参照される。
value この InPort にバインドされる T 型の変数
buffer_ InPort で使用するバッファのオブジェクト

InPort::getPortDataType  ) 
 

データ取得のためのメソッド データの型名を取得するため、InPortCorbaProviderから呼ばれる。 added by kurihara

InPort::init value   ) 
 

InPort 内のリングバッファの値を初期化.

InPort 内のリングバッファの値を初期化する。

InPort::isNew  ) 
 

InPort::name  ) 
 

InPort::read  ) 
 

DataPort から値を読み出す.

DataPort から値を読み出す

  • コールバックファンクタ OnRead がセットされている場合、 DataPort が保持するバッファから読み出す前に OnRead が呼ばれる。
  • DataPort が保持するバッファがアンダーフローを検出できるバッファで、 かつ、読み出す際にバッファがアンダーフローを検出した場合、 コールバックファンクタ OnUnderflow が呼ばれる。
  • コールバックファンクタ OnReadConvert がセットされている場合、 バッファ書き込み時に、OnReadConvert の operator()() の戻り値が read()の戻り値となる。
  • setReadTimeout() により読み出し時のタイムアウトが設定されている場合、 バッファアンダーフロー状態が解除されるまでタイムアウト時間だけ待ち、 OnUnderflowがセットされていればこれを呼び出して戻る

InPort::setOnOverflow on_overflow   ) 
 

InPort::setOnRead on_read   ) 
 

InPort::setOnReadConvert on_rconvert   ) 
 

InPort::setOnUnderflow on_underflow   ) 
 

InPort::setOnWrite on_write   ) 
 

InPort バッファにデータ入力時のコールバックの設定.

InPort が持つバッファにデータがputされたときに呼ばれるコールバック オブジェクトを設定する。設定されるコールバックオブジェクトは InPort<DataType>::OnPutクラスを継承し、引数 const DataType& 、 戻り値 void の operator() 関数が実装されている必要がある。

struct MyOnPutCallback : public InPort<DataType> {
void operator()(const DataType data) {
処理
}
};
のようにコールバックオブジェクトを実装し、

m_inport.setOnPut(new MyOnPutCallback());
のようにコールバックオブジェクトをセットする。

InPort::setOnWriteConvert on_wconvert   ) 
 

InPort::update  ) 
 

バインドされた変数self._valueに InPort バッファの最新値を読み込む

バインドされたデータに InPort の最新値を読み込む。

InPort::write value   ) 
 

DataPort に値を書き込む.

DataPort に値を書き込む。

  • コールバックファンクタ OnWrite がセットされている場合、 InPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
  • InPort が保持するバッファがオーバーフローを検出できるバッファであり、 かつ、書き込む際にバッファがオーバーフローを検出した場合、 コールバックファンクタ OnOverflow が呼ばれる。
  • コールバックファンクタ OnWriteConvert がセットされている場合、 バッファ書き込み時に、OnWriteConvert の operator()() の戻り値が バッファに書き込まれる。
  • setWriteTimeout() により書き込み時のタイムアウトが設定されている場合、 タイムアウト時間だけバッファフル状態が解除するのを待ち、 OnOverflowがセットされていればこれを呼び出して戻る。


このクラスの説明は次のファイルから生成されました:
OpenRTMに対してMon Oct 29 15:51:37 2007に生成されました。  doxygen 1.4.3