#include <OutPortConsumer.h>
Public メソッド | |
virtual DATAPORTSTATUS_ENUM | ~OutPortConsumer (void) |
デストラクタ | |
virtual void | init (coil::Properties &prop)=0 |
設定初期化 | |
virtual void | setBuffer (CdrBufferBase *buffer)=0 |
バッファをセットする | |
virtual ReturnCode | get (cdrMemoryStream &data)=0 |
データを受信する | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties)=0 |
データ受信通知への登録 | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties)=0 |
データ受信通知からの登録解除 | |
構成 | |
struct | subscribe |
Interface接続用Functor [詳細] | |
struct | unsubscribe |
Interface接続解除用Functor [詳細] |
出力ポートコンシューマのための抽象インターフェースクラス 各具象クラスは、以下の純粋仮想関数の実装を提供しなければならない。
virtual DATAPORTSTATUS_ENUM RTC::OutPortConsumer::~OutPortConsumer | ( | void | ) | [inline, virtual] |
デストラクタ
デストラクタ。
virtual void RTC::OutPortConsumer::init | ( | coil::Properties & | prop | ) | [pure virtual] |
設定初期化
OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。
prop | 設定情報 |
RTC::OutPortCorbaCdrConsumerで実装されています。
virtual void RTC::OutPortConsumer::setBuffer | ( | CdrBufferBase * | buffer | ) | [pure virtual] |
バッファをセットする
OutPortConsumerがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。
buffer | OutPortProviderがデータを取り出すバッファへのポインタ |
RTC::OutPortCorbaCdrConsumerで実装されています。
virtual ReturnCode RTC::OutPortConsumer::get | ( | cdrMemoryStream & | data | ) | [pure virtual] |
データを受信する
データ受信を実行するための純粋仮想関数。 具象クラスでは、それぞれの方法でリモートのOutPortからデータを 受信するロジックを実装する。 受信に関する状態に応じて以下の戻り値を返す。
data | 受信データ |
RTC::OutPortCorbaCdrConsumerで実装されています。
virtual bool RTC::OutPortConsumer::subscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [pure virtual] |
データ受信通知への登録
指定されたプロパティ情報に基づいて、データ受信通知に登録するための 純粋仮想関数。
properties | 登録用プロパティ |
RTC::OutPortCorbaCdrConsumer, と RTC::OutPortCorbaConsumer< DataType >で実装されています。
virtual void RTC::OutPortConsumer::unsubscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [pure virtual] |
データ受信通知からの登録解除
データ受信通知からの登録を解除するための純粋仮想関数。
properties | 登録解除用プロパティ |
RTC::OutPortCorbaCdrConsumer, と RTC::OutPortCorbaConsumer< DataType >で実装されています。