クラス OpenRTM_aist.OutPort.OutPort
OpenRTM_aist.OutPort.OutPortに対する継承グラフ
構成 | |
| class | subscribe |
Public メソッド | |
| def | __init__ |
| コンストラクタ | |
| def | __del__ |
| デストラクタ | |
| def | write |
| データ書き込み | |
| def | setOnWrite |
| データ書き込み処理のブロックモードの設定 | |
| def | setOnWriteConvert |
| OnWriteConvert コールバックの設定. | |
| def | getPortDataType |
| データ型名取得用メソッド | |
説明
OutPort クラス.
OutPort 用クラス
- から:
- 0.2.0
メソッド
| def OpenRTM_aist.OutPort.OutPort.__del__ | ( | self, | ||
PortBase = OpenRTM_aist.OutPortBase | ||||
| ) |
| def OpenRTM_aist.OutPort.OutPort.__init__ | ( | self, | ||
| name, | ||||
| value, | ||||
buffer = None | ||||
| ) |
コンストラクタ
コンストラクタ
- 引数:
-
self name ポート名 value このポートにバインドされるデータ変数 buffer_ バッファ
| def OpenRTM_aist.OutPort.OutPort.getPortDataType | ( | self | ) |
データ型名取得用メソッド
データの型名を取得するため、InPortCorbaProviderから呼ばれる。
- 引数:
-
self
- 戻り値:
- バッファに設定されているデータの型名
| def OpenRTM_aist.OutPort.OutPort.setOnWrite | ( | self, | ||
| on_write | ||||
| ) |
データ書き込み処理のブロックモードの設定
書き込み処理に対してブロックモードを設定する。 ブロックモードを指定した場合、バッファに書き込む領域ができるか タイムアウトが発生するまで write() メソッドの呼びだしがブロックされる。
- 引数:
-
self block ブロックモードフラグ
def setWriteBlock(self, block): self._writeBlock = block 書き込み処理のタイムアウト時間の設定 write() のタイムアウト時間を usec で設定する。 write() はブロックモードでなければならない。
- 引数:
-
self timeout タイムアウト時間 [usec]
def setWriteTimeout(self, timeout): self._writeTimeout = timeout OnWrite コールバックの設定 データ書き込み直前に呼ばれる OnWrite コールバックファンクタを設定する。
- 引数:
-
self on_write OnWrite コールバックファンクタ
| def OpenRTM_aist.OutPort.OutPort.setOnWriteConvert | ( | self, | ||
| on_wconvert | ||||
| ) |
OnWriteConvert コールバックの設定.
データ書き込み時に呼ばれる OnWriteConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が書き込まれる。 このため書き込みデータのフィルタリングが可能となる。
- 引数:
-
self on_wconvert OnWriteConvert コールバックファンクタ
| def OpenRTM_aist.OutPort.OutPort.write | ( | self, | ||
value = None | ||||
| ) |
データ書き込み
ポートへデータを書き込む。
- コールバックファンクタ OnWrite がセットされている場合、 OutPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
- OutPort が保持するバッファがオーバーフローを検出できるバッファであり、 かつ、書き込む際にバッファがオーバーフローを検出した場合、 コールバックファンクタ OnOverflow が呼ばれる。
- コールバックファンクタ OnWriteConvert がセットされている場合、 バッファ書き込み時に、 OnWriteConvert の operator() の戻り値が バッファに書き込まれる。
- 引数:
-
self value 書き込み対象データ
- 戻り値:
- 書き込み処理結果(書き込み成功:true、書き込み失敗:false)
virtual bool write(const DataType& value)
データ書き込み ポートへデータを書き込む。 設定された値をポートに書き込む。
- 引数:
-
self value 書き込み対象データ
- 戻り値:
- 書き込み処理結果(書き込み成功:true、書き込み失敗:false)
bool operator<<(DataType& value)
このクラスの説明は次のファイルから生成されました:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/OutPort.py
