クラス OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider
OutPortCorbaCdrProvider クラス. [詳細]
Public メソッド | |
| def | __init__ |
| コンストラクタ | |
| def | __del__ |
| def | init |
| 設定初期化 | |
| def | setBuffer |
| バッファをセットする | |
| def | setListener |
| リスナを設定する。 | |
| def | setConnector |
| Connectorを設定する。. | |
| def | get |
| [CORBA interface] バッファからデータを取得する | |
| def | onBufferRead |
| ON_BUFFER_READ のリスナへ通知する。. | |
| def | onSend |
| ON_SEND のリスナへ通知する。. | |
| def | onBufferEmpty |
| ON_BUFFER_EMPTYのリスナへ通知する。. | |
| def | onBufferReadTimeout |
| ON_BUFFER_READ_TIMEOUT のリスナへ通知する。. | |
| def | onSenderEmpty |
| ON_SENDER_EMPTYのリスナへ通知する。. | |
| def | onSenderTimeout |
| ON_SENDER_TIMEOUT のリスナへ通知する。. | |
| def | onSenderError |
| ON_SENDER_ERRORのリスナへ通知する。. | |
| def | convertReturn |
| リターンコード変換 | |
説明
OutPortProvider
データ転送に CORBA の OpenRTM.OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort プロバイダクラス。
- から:
- 0.4.0
メソッド
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__del__ | ( | self | ) |
デストラクタ
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__init__ | ( | self | ) |
コンストラクタ
コンストラクタ
- 引数:
-
buffer 当該プロバイダに割り当てるバッファオブジェクト
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.convertReturn | ( | self, | ||
| status, | ||||
| data | ||||
| ) |
リターンコード変換
OpenRTM.PortStatus convertReturn(BufferStatus.Enum status, const cdrMemoryStream& data);
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.get | ( | self | ) |
[CORBA interface] バッファからデータを取得する
設定された内部バッファからデータを取得する。
- 戻り値:
- 取得データ
virtual OpenRTM.PortStatus get(.OpenRTM.CdrData_out data);
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.init | ( | self, | ||
| prop | ||||
| ) |
設定初期化
InPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。
- 引数:
-
prop 設定情報
virtual void init(coil.Properties& prop);
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferEmpty | ( | self | ) |
ON_BUFFER_EMPTYのリスナへ通知する。.
inline void onBufferEmpty()
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferRead | ( | self, | ||
| data | ||||
| ) |
ON_BUFFER_READ のリスナへ通知する。.
- 引数:
-
data cdrMemoryStream
inline void onBufferRead(const cdrMemoryStream& data)
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferReadTimeout | ( | self | ) |
ON_BUFFER_READ_TIMEOUT のリスナへ通知する。.
inline void onBufferReadTimeout()
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSend | ( | self, | ||
| data | ||||
| ) |
ON_SEND のリスナへ通知する。.
- 引数:
-
data cdrMemoryStream
inline void onSend(const cdrMemoryStream& data)
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderEmpty | ( | self | ) |
ON_SENDER_EMPTYのリスナへ通知する。.
inline void onSenderEmpty()
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderError | ( | self | ) |
ON_SENDER_ERRORのリスナへ通知する。.
inline void onSenderError()
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderTimeout | ( | self | ) |
ON_SENDER_TIMEOUT のリスナへ通知する。.
inline void onSenderTimeout()
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setBuffer | ( | self, | ||
| buffer | ||||
| ) |
バッファをセットする
OutPortProviderがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。
- 引数:
-
buffer OutPortProviderがデータを取り出すバッファへのポインタ
virtual void setBuffer(BufferBase<cdrMemoryStream>* buffer);
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setConnector | ( | self, | ||
| connector | ||||
| ) |
Connectorを設定する。.
OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削 除してはいけない。
- 引数:
-
connector OutPortConnector
virtual void setConnector(OutPortConnector* connector);
| def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setListener | ( | self, | ||
| info, | ||||
| listeners | ||||
| ) |
リスナを設定する。
OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortCorbaCdrProvider では、以下のコールバック が提供される。
- ON_BUFFER_READ
- ON_SEND
- ON_BUFFER_EMPTY
- ON_BUFFER_READ_TIMEOUT
- ON_SENDER_EMPTY
- ON_SENDER_TIMEOUT
- ON_SENDER_ERROR
- 引数:
-
info 接続情報 listeners リスナオブジェクト
virtual void setListener(ConnectorInfo& info, ConnectorListeners* listeners);
このクラスの説明は次のファイルから生成されました:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/OutPortCorbaCdrProvider.py
