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サービスコンシューマはこの基底クラスを継承して実装される。

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

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

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

init(): 初期化関数。与えられた RTObject および ServiceProfile から、当該オブジェクトを初期化する。
reinit(): 再初期化関数。ServiceProfile は設定情報更新のため同一 IDで呼び出されることが有るが、その際にこの関数が新たな ServiceProfile とともに呼び出される。関数内では、設定の変更など再初期化処理を実装する。
getProfile(): 設定されたプロファイルを返す関数。
finalize(): 終了処理。コンシューマがデタッチされる際に呼び出される関数。関数内では終了処理を実装する。

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

実装クラス名: MySdoServiceConusmer
ファイル名: MySdoServiceConsumer.h. MySdoServiceConsumer.cpp
共有オブジェクト名: MySdoServiceConsumer.so (or DLL)
エントリポイント関数名: MySdoServiceConsumerInit()

エントリポイント関数は通常以下のように、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

終了処理

SDOサービスがでタッチされる際に呼び出される終了処理用関数。サービスのでタッチに際して、当該オブジェクトが保持するリソースを解放するなどの処理を行う。

◆ getProfile()

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

pure virtual

ServiceProfile を返す

init()/reinit()で与えられた ServiceProfile は通常オブジェクト内で保持される。SDO Service 管理フレームワークは管理上このオブジェクトに対応する ServiceProfile を必要とするので、この関数では保持されている ServiceProfile を返す。

戻り値: このオブジェクトが保持している ServiceProfile

◆ init()

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

pure virtual

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

このオブジェクトの初期化を行う。外部からSDOサービスが ServiceProfile とともにアタッチされると、SDOコンシューマがインスタンス化され、その直後に SDO サービスがアタッチされた RTC と与えられた ServiceProfile を引数としてこの関数が呼ばれる。

関数内では、ServiceProfile 内の SDO サービスリファレンスを CorbaConsumer クラス等を利用しオブジェクト内に保持するとともに、 properties から設定内容を読み込みサービス固有の設定等を行う。与えられたサービスのオブジェクトリファレンスが不正、あるいは properties の内容が不正、等の場合は戻り値に false を返す。

引数

rtobj	このオブジェクトがインスタンス化された RTC
profile	外部から与えられた SDO ServiceProfile

戻り値: 与えられた SDO Service や ServiceProfile が不正の場合 false

◆ reinit()

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

pure virtual

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

このオブジェクトの再初期化を行う。ServiceProfile には id フィールドにセッション固有の UUID がセットされているが、同一の id の場合、properties に設定された設定情報の変更や、service フィールドのサービスの参照の変更が行われる。その際に呼ばれるのがこの reinit() 関数である。実装では、service フィールドのオブジェクトリファレンスの同一性を確認し、異なっている場合保持しているリファレンスを更新する必要がある。また properties には新たな設定が与えられている可能性があるので、内容を読み込み設定を更新する。

引数

profile 新たに与えられた SDO ServiceProfile

戻り値: 不正な ServiceProfile が与えられた場合は false

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

SdoServiceConsumerBase.h

公開メンバ関数

詳解

構築子と解体子

◆ ~SdoServiceConsumerBase()

関数詳解

◆ finalize()

◆ getProfile()

◆ init()

◆ reinit()