OpenRTM  1.0.0
Public メソッド | すべてのメンバ一覧
クラス RTC::OutPortCorbaCdrProvider

OutPortCorbaCdrProvider クラス [詳細]

#include <OutPortCorbaCdrProvider.h>

RTC::OutPortCorbaCdrProviderに対する継承グラフ
RTC::OutPortProvider RTC::DataPortStatus

Public メソッド

 OutPortCorbaCdrProvider (void)
 
virtual ~OutPortCorbaCdrProvider (void)
 
virtual void init (coil::Properties &prop)
 設定初期化 [詳細]
 
virtual void setBuffer (CdrBufferBase *buffer)
 バッファをセットする [詳細]
 
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 リスナを設定する。 [詳細]
 
virtual void setConnector (OutPortConnector *connector)
 Connectorを設定する。 [詳細]
 
virtual ::OpenRTM::PortStatus get (::OpenRTM::CdrData_out data) throw (CORBA::SystemException)
 [CORBA interface] バッファからデータを取得する [詳細]
 
- Public メソッド inherited from RTC::OutPortProvider
virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 デストラクタ [詳細]
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 InterfaceProfile情報を公開する [詳細]
 
virtual bool publishInterface (SDOPackage::NVList &properties)
 Interface情報を公開する [詳細]
 

Additional Inherited Members

- Public 型 inherited from RTC::DataPortStatus
enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 
- Static Public メソッド inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 DataPortStatus リターンコードを文字列に変換 [詳細]
 
- Protected メソッド inherited from RTC::OutPortProvider
void setPortType (const char *port_type)
 ポートタイプを設定する [詳細]
 
void setDataType (const char *data_type)
 データタイプを設定する [詳細]
 
void setInterfaceType (const char *interface_type)
 インターフェースタイプを設定する [詳細]
 
void setDataFlowType (const char *dataflow_type)
 データフロータイプを設定する [詳細]
 
void setSubscriptionType (const char *subs_type)
 サブスクリプションタイプを設定する [詳細]
 
- Protected 変数 inherited from RTC::OutPortProvider
SDOPackage::NVList m_properties
 ポートプロファイルを保持するプロパティ [詳細]
 
Logger rtclog
 ロガーストリーム [詳細]
 

説明

OutPortCorbaCdrProvider クラス

OutPortProvider

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

から
0.4.0

コンストラクタとデストラクタ

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider ( void  )

コンストラクタ

virtual RTC::OutPortCorbaCdrProvider::~OutPortCorbaCdrProvider ( void  )
virtual

デストラクタ

関数

virtual ::OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get ( ::OpenRTM::CdrData_out  data)
throw (CORBA::SystemException
)

[CORBA interface] バッファからデータを取得する

設定された内部バッファからデータを取得する。

戻り値
取得データ
virtual void RTC::OutPortCorbaCdrProvider::init ( coil::Properties prop)
virtual

設定初期化

OutPortCorbaCdrProvider の各種設定を行う。与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。

引数
prop設定情報

RTC::OutPortProviderを再定義しています。

virtual void RTC::OutPortCorbaCdrProvider::setBuffer ( CdrBufferBase buffer)
virtual

バッファをセットする

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

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

RTC::OutPortProviderを実装しています。

virtual void RTC::OutPortCorbaCdrProvider::setConnector ( OutPortConnector connector)
virtual

Connectorを設定する。

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

引数
connectorOutPortConnector

RTC::OutPortProviderを実装しています。

virtual void RTC::OutPortCorbaCdrProvider::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
)
virtual

リスナを設定する。

OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.hConnectorDataListener, 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リスナオブジェクト

RTC::OutPortProviderを実装しています。