OpenRTM-aist  1.2.1
クラス | 公開メンバ関数 | 限定公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
RTC::InPortProvider クラスabstract

#include <InPortProvider.h>

RTC::InPortProvider の継承関係図
Inheritance graph
[凡例]
RTC::InPortProvider 連携図
Collaboration graph
[凡例]

クラス

struct  publishInterfaceFunc
 インターフェースプロファイルを公開するたのファンクタ [詳解]
 
struct  publishInterfaceProfileFunc
 インターフェースプロファイルを公開するたのファンクタ [詳解]
 

公開メンバ関数

DATAPORTSTATUS_ENUM InPortProvider ()
 コンストラクタ [詳解]
 
virtual ~InPortProvider (void)
 デストラクタ [詳解]
 
virtual void init (coil::Properties &prop)=0
 設定初期化 [詳解]
 
virtual void setBuffer (BufferBase< cdrMemoryStream > *buffer)=0
 バッファをセットする [詳解]
 
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0
 リスナを設定する。 [詳解]
 
virtual void setConnector (InPortConnector *connector)=0
 Connectorを設定する。 [詳解]
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 InterfaceProfile情報を公開する [詳解]
 
virtual bool publishInterface (SDOPackage::NVList &properties)
 Interface情報を公開する [詳解]
 

限定公開メンバ関数

void setInterfaceType (const char *interface_type)
 インタフェースタイプを設定する [詳解]
 
void setDataFlowType (const char *dataflow_type)
 データフロータイプを設定する [詳解]
 
void setSubscriptionType (const char *subs_type)
 サブスクリプションタイプを設定する [詳解]
 

限定公開変数類

SDOPackage::NVList m_properties
 ポートプロファイルを保持するプロパティ [詳解]
 
Logger rtclog
 ロガーストリーム [詳解]
 

その他の継承メンバ

- 基底クラス 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
}
 
- 基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char * toString (DataPortStatus::Enum status)
 DataPortStatus リターンコードを文字列に変換 [詳解]
 

構築子と解体子

DATAPORTSTATUS_ENUM RTC::InPortProvider::InPortProvider ( )

コンストラクタ

コンストラクタ

virtual RTC::InPortProvider::~InPortProvider ( void  )
virtual

デストラクタ

仮想デストラクタ

関数詳解

virtual void RTC::InPortProvider::init ( coil::Properties &  prop)
pure virtual

設定初期化

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

引数
prop設定情報

RTC::InPortCorbaCdrProvider, RTC::InPortDirectProvider, RTC::InPortSHMProviderで実装されています。

virtual bool RTC::InPortProvider::publishInterface ( SDOPackage::NVList &  properties)
virtual

Interface情報を公開する

Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポー トに設定されていなければNameValue に情報を追加する。すでに同一イ ンターフェースが登録済みの場合は何も行わない。

引数
propertiesInterface情報を受け取るプロパティ
戻り値
true: 正常終了

参照元 RTC::InPortProvider::publishInterfaceFunc::operator()().

virtual void RTC::InPortProvider::publishInterfaceProfile ( SDOPackage::NVList &  properties)
virtual

InterfaceProfile情報を公開する

InterfaceProfile情報を公開する。 引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されている インターフェースタイプと一致する場合のみ情報を取得する。

引数
propertiesInterfaceProfile情報を受け取るプロパティ

参照元 RTC::InPortProvider::publishInterfaceProfileFunc::operator()().

virtual void RTC::InPortProvider::setBuffer ( BufferBase< cdrMemoryStream > *  buffer)
pure virtual

バッファをセットする

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

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

RTC::InPortCorbaCdrProvider, RTC::InPortDirectProvider, RTC::InPortSHMProviderで実装されています。

virtual void RTC::InPortProvider::setConnector ( InPortConnector *  connector)
pure virtual

Connectorを設定する。

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

引数
connectorOutPortConnector

RTC::InPortCorbaCdrProvider, RTC::InPortDirectProvider, RTC::InPortSHMProviderで実装されています。

void RTC::InPortProvider::setDataFlowType ( const char *  dataflow_type)
protected

データフロータイプを設定する

データフロータイプを設定する。

引数
dataflow_type設定対象データフロータイプ
void RTC::InPortProvider::setInterfaceType ( const char *  interface_type)
protected

インタフェースタイプを設定する

インタフェースタイプを設定する。

引数
interface_type設定対象インタフェースタイプ
virtual void RTC::InPortProvider::setListener ( ConnectorInfo &  info,
ConnectorListeners *  listeners 
)
pure virtual

リスナを設定する。

OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortProvider のサブクラスでは、与えられたリス ナを適切なタイミングで呼び出すべきである。ただし、すべてのリスナ を呼び出す必要はない。

引数
info接続情報
listenersリスナオブジェクト

RTC::InPortCorbaCdrProvider, RTC::InPortDirectProvider, RTC::InPortSHMProviderで実装されています。

void RTC::InPortProvider::setSubscriptionType ( const char *  subs_type)
protected

サブスクリプションタイプを設定する

サブスクリプションタイプを設定する。

引数
subs_type設定対象サブスクリプションタイプ

メンバ詳解

SDOPackage::NVList RTC::InPortProvider::m_properties
protected

ポートプロファイルを保持するプロパティ

Logger RTC::InPortProvider::rtclog
mutableprotected

ロガーストリーム

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