#include <InPortProvider.h>
クラス | |
| struct | publishInterfaceFunc |
| インターフェースプロファイルを公開するたのファンクタ [詳解] | |
| struct | publishInterfaceProfileFunc |
| インターフェースプロファイルを公開するたのファンクタ [詳解] | |
公開メンバ関数 | |
| InPortProvider () | |
| コンストラクタ | |
| virtual | ~InPortProvider () |
| デストラクタ | |
| virtual void | init (coil::Properties &prop)=0 |
| 設定初期化 | |
| virtual void | setBuffer (BufferBase< ByteData > *buffer)=0 |
| バッファをセットする | |
| virtual void | setListener (ConnectorInfo &info, ConnectorListenersBase *listeners)=0 |
| リスナを設定する。 | |
| virtual void | setConnector (InPortConnector *connector)=0 |
| Connectorを設定する。 | |
| virtual void | publishInterfaceProfile (SDOPackage::NVList &prop) |
| InterfaceProfile情報を公開する | |
| virtual bool | publishInterface (SDOPackage::NVList &prop) |
| 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 |
| ロガーストリーム | |
構築子と解体子
◆ InPortProvider()
| RTC::InPortProvider::InPortProvider | ( | ) |
コンストラクタ
コンストラクタ
◆ ~InPortProvider()
|
virtual |
デストラクタ
仮想デストラクタ
関数詳解
◆ init()
|
pure virtual |
設定初期化
OutPortProvider の各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。
- 引数
-
prop 設定情報
RTC::InPortCorbaCdrProvider, RTC::InPortCorbaCdrUDPProvider, RTC::InPortDirectProvider, RTC::InPortDSProvider, RTC::InPortSHMProviderで実装されています。
◆ publishInterface()
|
virtual |
Interface情報を公開する
Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポー トに設定されていなければNameValue に情報を追加する。すでに同一イ ンターフェースが登録済みの場合は何も行わない。
- 引数
-
properties Interface情報を受け取るプロパティ
- 戻り値
- true: 正常終了
参照元 RTC::InPortProvider::publishInterfaceFunc::operator()().
◆ publishInterfaceProfile()
|
virtual |
InterfaceProfile情報を公開する
InterfaceProfile情報を公開する。 引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されている インターフェースタイプと一致する場合のみ情報を取得する。
- 引数
-
properties InterfaceProfile情報を受け取るプロパティ
参照元 RTC::InPortProvider::publishInterfaceProfileFunc::operator()().
◆ setBuffer()
|
pure virtual |
バッファをセットする
OutPortProviderがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。
- 引数
-
buffer OutPortProviderがデータを取り出すバッファへのポインタ
RTC::InPortCorbaCdrProvider, RTC::InPortCorbaCdrUDPProvider, RTC::InPortDirectProvider, RTC::InPortDSProvider, RTC::InPortSHMProviderで実装されています。
◆ setConnector()
|
pure virtual |
Connectorを設定する。
OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削 除してはいけない。
- 引数
-
connector OutPortConnector
RTC::InPortCorbaCdrProvider, RTC::InPortCorbaCdrUDPProvider, RTC::InPortDirectProvider, RTC::InPortDSProvider, RTC::InPortSHMProviderで実装されています。
◆ setDataFlowType()
|
protected |
データフロータイプを設定する
データフロータイプを設定する。
- 引数
-
dataflow_type 設定対象データフロータイプ
◆ setInterfaceType()
|
protected |
インタフェースタイプを設定する
インタフェースタイプを設定する。
- 引数
-
interface_type 設定対象インタフェースタイプ
◆ setListener()
|
pure virtual |
リスナを設定する。
OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortProvider のサブクラスでは、与えられたリス ナを適切なタイミングで呼び出すべきである。ただし、すべてのリスナ を呼び出す必要はない。
- 引数
-
info 接続情報 listeners リスナオブジェクト
RTC::InPortCorbaCdrProvider, RTC::InPortCorbaCdrUDPProvider, RTC::InPortDirectProvider, RTC::InPortDSProvider, RTC::InPortSHMProviderで実装されています。
◆ setSubscriptionType()
|
protected |
サブスクリプションタイプを設定する
サブスクリプションタイプを設定する。
- 引数
-
subs_type 設定対象サブスクリプションタイプ
メンバ詳解
◆ m_properties
|
protected |
ポートプロファイルを保持するプロパティ
◆ rtclog
|
mutableprotected |
ロガーストリーム
このクラス詳解は次のファイルから抽出されました:
構築:
1.11.0