クラス OpenRTM_aist.InPortPushConnector.InPortPushConnector
InPortPushConnector クラス. [詳細]
Public メソッド | |
| def | __init__ |
| コンストラクタ | |
| def | __del__ |
| デストラクタ | |
| def | read |
| データの読み出し | |
| def | disconnect |
| 接続解除 | |
| def | activate |
| アクティブ化 | |
| def | deactivate |
| 非アクティブ化 | |
| def | createBuffer |
| Bufferの生成. | |
| def | write |
| データの書き出し | |
| def | onConnect |
| 接続確立時にコールバックを呼ぶvoid onConnect() | |
| def | onDisconnect |
| 接続切断時にコールバックを呼ぶvoid onDisconnect() | |
説明
InPortPushConnector クラス.
InPort の push 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に push が指定された場合、 InPort によって生成・所有され、OutPortPushConnector と対になって、 データポートの push 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。
InPortPushConnector は以下の三つのオブジェクトを所有し管理する。
- InPortProvider
- Buffer
OutPort に書き込まれたデータは、OutPortConnector によって InPortProvider.put() にデータが渡される。書き込まれたデータは Connector 内で Buffer にデータが書き込まれる。
- から:
- 1.0.0
メソッド
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.__del__ | ( | self | ) |
デストラクタ
disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.__init__ | ( | self, | ||
| info, | ||||
| provider, | ||||
| listeners, | ||||
buffer = 0 | ||||
| ) |
コンストラクタ
InPortPushConnector のコンストラクタはオブジェクト生成時に下記を 引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッファ 等を生成する。InPort インターフェースのプロバイダオブジェクトへ のポインタを取り、所有権を持つので、InPortPushConnector は InPortProvider の解体責任を持つ。各種イベントに対するコールバッ ク機構を提供する ConnectorListeners を持ち、適切なタイミングでコー ルバックを呼び出す。データバッファがもし InPortBase から提供され る場合はそのポインタを取る。
- 引数:
-
info ConnectorInfo provider InPortProvider listeners ConnectorListeners 型のリスナオブジェクトリスト buffer CdrBufferBase 型のバッファ
Constructor InPortPushConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a buffer is created. It is also given a pointer to the provider object for the InPort interface. The owner-ship of the pointer is owned by this InPortPushConnector, it has responsibility to destruct the InPortProvider. InPortPushConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by InPortBase, the pointer to the buffer is also given as arguments.
- 引数:
-
info ConnectorInfo provider InPortProvider listeners ConnectorListeners type lsitener object list buffer CdrBufferBase type buffer
InPortPushConnector(ConnectorInfo info, InPortProvider* provider, ConnectorListeners listeners, CdrBufferBase* buffer = 0);
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.activate | ( | self | ) |
アクティブ化
このコネクタをアクティブ化する
virtual void activate(){}; // do nothing
OpenRTM_aist.ConnectorBase.ConnectorBaseを再定義しています。
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.createBuffer | ( | self, | ||
| profile | ||||
| ) |
Bufferの生成.
与えられた接続情報に基づきバッファを生成する。
- 引数:
-
info 接続情報
- 戻り値:
- バッファへのポインタ
virtual CdrBufferBase* createBuffer(Profile& profile);
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.deactivate | ( | self | ) |
非アクティブ化
このコネクタを非アクティブ化する
virtual void deactivate(){}; // do nothing
OpenRTM_aist.ConnectorBase.ConnectorBaseを再定義しています。
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.disconnect | ( | self | ) |
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.read | ( | self, | ||
| data | ||||
| ) |
データの読み出し
バッファからデータを読み出す。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外 の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。
- 戻り値:
- PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー
virtual ReturnCode read(cdrMemoryStream& data);
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.write | ( | self, | ||
| data | ||||
| ) |
データの書き出し
バッファにデータを書き出す。正常に書き出せた場合、戻り値は BUFFER_OK となる。それ以外の場合には、エラー値として BUFFER_FULL,TIMEOUT PRECONDITION_NOT_MET, BUFFER_ERROR が返される。
- 戻り値:
- BUFFER_OK 正常終了 BUFFER_FULL バッファはいっぱいである TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない BUFFER_ERROR その他のエラー
ReturnCode write(const OpenRTM.CdrData& data);
このクラスの説明は次のファイルから生成されました:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/InPortPushConnector.py
