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

OutPortCorbaCdrProvider クラス [詳解]

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider の継承関係図
OpenRTM_aist.OutPortProvider.OutPortProvider OpenRTM_aist.DataPortStatus.DataPortStatus

公開メンバ関数

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のリスナへ通知する。inline void onBufferEmpty()
 
def onBufferReadTimeout
 ON_BUFFER_READ_TIMEOUT のリスナへ通知する。inline void onBufferReadTimeout()
 
def onSenderEmpty
 ON_SENDER_EMPTYのリスナへ通知する。inline void onSenderEmpty()
 
def onSenderTimeout
 ON_SENDER_TIMEOUT のリスナへ通知する。inline void onSenderTimeout()
 
def onSenderError
 ON_SENDER_ERRORのリスナへ通知する。inline void onSenderError()
 
def convertReturn
 リターンコード変換::OpenRTM::PortStatus convertReturn(BufferStatus::Enum status, const cdrMemoryStream& data);
 
- 基底クラス OpenRTM_aist.OutPortProvider.OutPortProvider に属する継承公開メンバ関数
def __init__
 コンストラクタ [詳解]
 
def publishInterfaceProfile
 InterfaceProfile情報を公開する [詳解]
 
def publishInterface
 Interface情報を公開する [詳解]
 
def setPortType
 ポートタイプを設定する [詳解]
 
def setDataType
 データタイプを設定する [詳解]
 
def setInterfaceType
 インターフェースタイプを設定する [詳解]
 
def setDataFlowType
 データフロータイプを設定する [詳解]
 
def setSubscriptionType
 サブスクリプションタイプを設定する [詳解]
 
- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def toString
 DataPortStatus リターンコードを文字列に変換 [詳解]
 

その他の継承メンバ

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

詳解

OutPortCorbaCdrProvider クラス

OutPortProvider

データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort プロバイダクラス。

から
0.4.0

構築子と解体子

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__init__ (   self)

コンストラクタ

コンストラクタ

引数
buffer当該プロバイダに割り当てるバッファオブジェクト
def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__del__ (   self)

デストラクタ

デストラクタ

メソッド詳解

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.onBufferRead (   self,
  data 
)

ON_BUFFER_READ のリスナへ通知する。

引数
datacdrMemoryStream

inline void onBufferRead(const cdrMemoryStream& data)

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSend (   self,
  data 
)

ON_SEND のリスナへ通知する。

引数
datacdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setBuffer (   self,
  buffer 
)

バッファをセットする

OutPortProviderがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。

引数
bufferOutPortProviderがデータを取り出すバッファへのポインタ

virtual void setBuffer(BufferBase<cdrMemoryStream>* buffer);

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setConnector (   self,
  connector 
)

Connectorを設定する。

OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削 除してはいけない。

引数
connectorOutPortConnector

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);


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