OpenRTM-aist 2.1.0
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 全メンバ一覧
RTC::SdoServiceConsumerBase クラスabstract

SdoServiceConsumer 基底クラス [詳解]

#include <SdoServiceConsumerBase.h>

公開メンバ関数

virtual ~SdoServiceConsumerBase ()=default
 仮想デストラクタ
 
virtual bool init (RTObject_impl &rtobj, const SDOPackage::ServiceProfile &profile)=0
 コンシューマクラスの初期化関数
 
virtual bool reinit (const SDOPackage::ServiceProfile &profile)=0
 コンシューマクラスの再初期化関数
 
virtual const SDOPackage::ServiceProfile & getProfile () const =0
 ServiceProfile を返す
 
virtual void finalize ()=0
 終了処理
 

詳解

SdoServiceConsumer 基底クラス

SDOで定義されているSDOサービスのコンシューマを実装するための基底ク ラス。SDOサービスには、外部から提供サービスをRTC(SDO)側で利用する SDOサービスコンシューマと、RTC(SDO)自身がSDOサービスを提供するSDO サービスプロバイダがある。すべてのSDOサービスコンシューマはこの基 底クラスを継承して実装される。

このオブジェクトのライフサイクルは以下の通り。

  1. オブジェクトは通常、共有オブジェクト (so, DLL) としてコンパイル・ リンクされる。
  2. マネージャに対してロードされるとモジュール初期化関数によりオブ ジェクトファクトリが、SdoServiceConsumerFactory に対して登録さ れる。登録のキーにはサービスインターフェースの IFR (interface repository) ID が利用され、これによりサービスが区別される。
  3. 外部のツールなどからサービスプロバイダがアタッチされた場合、サー ビスインターフェースの IFR ID が同一である SDO コンシューマがイ ンスタンス化され、提供されたSDOサービスの ServiceProfile (この 構造体はサービスのオブジェクトリファレンスを含む) がコンシュー マにアタッチされる。
  4. このときのアタッチシーケンスは以下の通り。
    1. SDO::get_configuration() により Configuration オブジェクトを取得
    2. Configuration::add_service_profile() により外部側の SdoServiceProvider を ServiceProfile により RTC に与える。
    3. RTC側でサービスを呼び出す必要が有った場合、この SdoServiceConsumer が保持しているサービスオブジェクトプロキシ に対して呼び出しを行う
  5. 最終的に SdoServiceConsumer が不要になった場合には、 Configuration::remove_service_profile() が id とともに呼び出され SDOサービスコンシューマが RTC から削除される。

  [RTC] [SDO consumer] [Configuration]  [SDO service]    [Other]
    |          :             |                 |            |
    |          :         get_configuration()   |            |
    |<---------:-------------------------------|------------|
    |          :             |                 |            |
    |          :             |   add_service_profile(prof)  |
    |          :  create()   |<----------------|------------|
    |          |<------------|                 |            |
    |          |         call_sdo_service()    |            |
    |          |-------------|---------------->|            |
    |          |         call_sdo_service2()   |            |
    |          |-------------|---------------->|            |
    |          |             |       :         |            |
    |          |             |                 |            |
    |          |             | remove_service_profile(id)   |
    |          |  delete()   |<----------------|------------|
    |          x<------------|                 |            |
    |                        |                 x            x

このクラスの実装に当たっては、少なくとも以下の純粋仮想関数を実装す る必要がある。

SdoServiceConsumer は通常共有オブジェクトとしてコンパイル・リンク される。共有オブジェクトのエントリポイントは通常コンパイルされたファ イル名の basename + "Init" にしておく。以下に、クラス名、ファイル 名、エントリポイント関数名の推奨例を示す。

エントリポイント関数は通常以下のように、SdoServiceConsumerFactory に当該コンシューマのファクトリ (と解体ファンクタ) を登録する以下の ような関数になる。

extern "C"
{
  void MySdoServiceConsumerInit()
  {
    RTC::SdoServiceConsumerFactory& factory
      = RTC::SdoServiceConsumerFactory::instance();
    factory.addFactory(CORBA_Util::toRepositoryId<OpenRTM::MySdoService>(),
                       ::coil::Creator< ::RTC::SdoServiceConsumerBase,
                       ::RTC::MySdoServiceConsumer>,
                       ::coil::Destructor< ::RTC::SdoServiceConsumerBase,
                       ::RTC::MySdoServiceConsumer>);
  }
};

構築子と解体子

◆ ~SdoServiceConsumerBase()

virtual RTC::SdoServiceConsumerBase::~SdoServiceConsumerBase ( )
virtualdefault

仮想デストラクタ

関数詳解

◆ finalize()

virtual void RTC::SdoServiceConsumerBase::finalize ( )
pure virtual

終了処理

◆ getProfile()

virtual const SDOPackage::ServiceProfile & RTC::SdoServiceConsumerBase::getProfile ( ) const
pure virtual

ServiceProfile を返す

◆ init()

virtual bool RTC::SdoServiceConsumerBase::init ( RTObject_impl rtobj,
const SDOPackage::ServiceProfile &  profile 
)
pure virtual

コンシューマクラスの初期化関数

◆ reinit()

virtual bool RTC::SdoServiceConsumerBase::reinit ( const SDOPackage::ServiceProfile &  profile)
pure virtual

コンシューマクラスの再初期化関数


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