OpenRTM-aist-Python 1.1.2
|
公開メンバ関数 | |
def | __init__ (self, info, provider, listeners, buffer=0) |
コンストラクタ [詳解] | |
def | __del__ (self) |
デストラクタ [詳解] | |
def | read (self, data) |
データの読み出し [詳解] | |
def | disconnect (self) |
接続解除 [詳解] | |
def | activate (self) |
アクティブ化 [詳解] | |
def | deactivate (self) |
非アクティブ化 [詳解] | |
def | createBuffer (self, profile) |
Bufferの生成 [詳解] | |
def | write (self, data) |
データの書き出し [詳解] | |
def | onConnect (self) |
接続確立時にコールバックを呼ぶ void onConnect() | |
def | onDisconnect (self) |
接続切断時にコールバックを呼ぶ void onDisconnect() | |
基底クラス OpenRTM_aist.InPortConnector.InPortConnector に属する継承公開メンバ関数 | |
def | __init__ (self, info, buffer) |
コンストラクタInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer); | |
def | __del__ (self) |
デストラクタ | |
def | profile (self) |
ConnectorInfo 取得 [詳解] | |
def | id (self) |
Connector ID 取得 [詳解] | |
def | name (self) |
Connector 名取得 [詳解] | |
def | disconnect (self) |
接続解除関数 [詳解] | |
def | getBuffer (self) |
Buffer を所得する [詳解] | |
def | read (self, data) |
read 関数 [詳解] | |
基底クラス OpenRTM_aist.ConnectorBase.ConnectorBase に属する継承公開メンバ関数 | |
def | __del__ (self) |
デストラクタ | |
def | profile (self) |
Profile 取得 [詳解] | |
def | id (self) |
Connector ID 取得 [詳解] | |
def | name (self) |
Connector 名取得 [詳解] | |
def | disconnect (self) |
接続解除関数 [詳解] | |
def | getBuffer (self) |
Buffer を取得する [詳解] | |
def | activate (self) |
アクティブ化 [詳解] | |
def | deactivate (self) |
非アクティブ化 [詳解] | |
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数 | |
def | toString (status) |
DataPortStatus リターンコードを文字列に変換 [詳解] | |
その他の継承メンバ | |
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類 | |
int | PORT_OK = 0 |
brief DataPortStatus リターンコード [詳解] | |
InPort の push 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に push が指定された場合、 InPort によって生成・所有され、OutPortPushConnector と対になって、 データポートの push 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。
InPortPushConnector は以下の三つのオブジェクトを所有し管理する。
OutPort に書き込まれたデータは、OutPortConnector によって InPortProvider::put() にデータが渡される。書き込まれたデータは Connector 内で 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.__del__ | ( | self | ) |
デストラクタ
disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.activate | ( | self | ) |
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.createBuffer | ( | self, | |
profile | |||
) |
Bufferの生成
与えられた接続情報に基づきバッファを生成する。
info | 接続情報 |
virtual CdrBufferBase* createBuffer(Profile& profile);
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.deactivate | ( | self | ) |
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 が返される。
virtual ReturnCode read(cdrMemoryStream& data); buffer returns BUFFER_OK BUFFER_EMPTY TIMEOUT PRECONDITION_NOT_MET
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.write | ( | self, | |
data | |||
) |
データの書き出し
バッファにデータを書き出す。正常に書き出せた場合、戻り値は BUFFER_OK となる。それ以外の場合には、エラー値として BUFFER_FULL,TIMEOUT PRECONDITION_NOT_MET, BUFFER_ERROR が返される。
ReturnCode write(const OpenRTM::CdrData& data);