OpenRTM-aist-Python 2.0.0
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.OutPortPullConnector.OutPortPullConnector クラス

[詳解]

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector の継承関係図
OpenRTM_aist.OutPortConnector.OutPortConnector OpenRTM_aist.ConnectorBase.ConnectorBase OpenRTM_aist.DataPortStatus.DataPortStatus

クラス

class  WorkerThreadCtrl
 

公開メンバ関数

def __init__ (self, info, provider, listeners, buffer=None)
 
def __del__ (self)
 
def write (self, data)
 
def disconnect (self)
 
def getBuffer (self)
 
def activate (self)
 
def deactivate (self)
 
def createBuffer (self, info)
 
def onConnect (self)
 
def onDisconnect (self)
 
def setDirectMode (self)
 
- 基底クラス OpenRTM_aist.OutPortConnector.OutPortConnector に属する継承公開メンバ関数
def __init__ (self, info)
 
def __del__ (self)
 
def profile (self)
 
def id (self)
 
def name (self)
 
def setDirectMode (self)
 
def directMode (self)
 
def setConsumer (self, consumer)
 
def unsubscribeInterface (self, prop)
 
def __del__ (self)
 
def profile (self)
 
def id (self)
 
def name (self)
 
def disconnect (self)
 
def getBuffer (self)
 
def activate (self)
 
def deactivate (self)
 
- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def toString (status)
 

その他の継承メンバ

- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類
int PORT_OK = 0
 brief DataPortStatus リターンコード [詳解]
 

詳解

OutPortPullConnector クラス

OutPort の pull 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に pull が指定された場合、 OutPort によって生成・所有され、InPortPullConnector と対になって、 データポートの pull 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。

OutPortPullConnector は以下の三つのオブジェクトを所有し管理する。

OutPort に書き込まれたデータは OutPortPullConnector::write() に渡 され Buffer に書き込まれる。InPortPullConnector が OutPortPullConnector からデータを読み出すことで InPort にデータが 転送される。

から
1.0.0

構築子と解体子

◆ __init__()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__init__ (   self,
  info,
  provider,
  listeners,
  buffer = None 
)

コンストラクタ

OutPortPullConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッ ファ等を生成する。OutPort インターフェースのプロバイダオブジェク トへのポインタを取り、所有権を持つので、OutPortPullConnector は OutPortProvider の解体責任を持つ。各種イベントに対するコールバッ ク機構を提供する ConnectorListeners を持ち、適切なタイミングでコー ルバックを呼び出す。データバッファがもし OutPortBase から提供さ れる場合はそのポインタを取る。

引数
infoConnectorInfo
providerOutPortProvider
listenersConnectorListeners 型のリスナオブジェクトリスト
bufferCdrBufferBase 型のバッファ

OutPortPullConnector(ConnectorInfo info, OutPortProvider* provider, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

◆ __del__()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__del__ (   self)

デストラクタ

disconnect() が呼ばれ、provider, buffer が解体・削除される。

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

メソッド詳解

◆ activate()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.activate (   self)

アクティブ化

このコネクタをアクティブ化する

virtual void activate(){}; // do nothing

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

◆ createBuffer()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.createBuffer (   self,
  info 
)

Bufferの生成

CdrBufferBase* createBuffer(ConnectorInfo& info);

◆ deactivate()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.deactivate (   self)

非アクティブ化

このコネクタを非アクティブ化する

virtual void deactivate(){}; // do nothing

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

◆ disconnect()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.disconnect (   self)

接続解除

consumer, publisher, buffer が解体・削除される。

virtual ReturnCode disconnect();

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

◆ getBuffer()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.getBuffer (   self)

Buffer を取得する

Connector が保持している Buffer を返す

virtual CdrBufferBase* getBuffer();

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

◆ onConnect()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onConnect (   self)

接続確立時にコールバックを呼ぶ void onConnect()

◆ onDisconnect()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onDisconnect (   self)

接続切断時にコールバックを呼ぶ void onDisconnect()

◆ setDirectMode()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.setDirectMode (   self)

ダイレクト接続モードに設定 void onDisconnect()

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

◆ write()

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.write (   self,
  data 
)

データの書き込み

Publisherに対してデータを書き込み、これにより対応するInPortへ データが転送される。

virtual ReturnCode write(const cdrMemoryStream& data);

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。


このクラス詳解は次のファイルから抽出されました: