SdoServiceProvider　基底クラス [詳解]

#include <SdoServiceProviderBase.h>

RTC::SdoServiceProviderBase の継承関係図

[凡例]

RTC::SdoServiceProviderBase 連携図

[凡例]

公開メンバ関数
	~SdoServiceProviderBase () override
	仮想デストラクタ

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
	終了処理

詳解

SdoServiceProvider　基底クラス

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

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

オブジェクトは通常、共有オブジェクト (so, DLL) としてコンパイル・リンクされる。
マネージャに対してロードされるとモジュール初期化関数によりオブジェクトファクトリが、SdoServiceProviderFactory に対して登録される。登録のキーにはサービスインターフェースの IFR (interface repository) ID が利用され、これによりサービスが区別される。
rtc.conf等のコンフィギュレーション指定により、有効化することが指定されているサービスインプロバイダは、RTCの起動と同時にインスタンス化される。
インスタンス化後、初期化関数 init() が呼ばれる。引数には当該サービスのためのコンフィギュレーションオプションが coil::Propertyにより渡される。
インスタンス化されたSDOサービスプロバイダは SDO::get_sdo_service() により外部からアクセスされる。このとき、サービスを指定するIDはIFR IDと同じである。このときのアタッチシーケンスは以下の通り。
RTCがfinalizeされ解体されると同時にSDOサービスプロバイダも解体されるが、その際にはSdoServiceProviderBase::finalize()がコールされるので、ここでリソースの解放など終了処理を行う。


  [RTC]      [SDO service]               [Other]
    |              :                        |
    | instantiate  :                        |
    |------------->:                        |
    |    init()    |                        |
    |------------->|                        |
    |              | get_service_profiles() |
    |<--------------------------------------|
    |              |    get_sdo_service()   |
    |<--------------------------------------|
    |              |        use service     |
    |              |<-----------------------|
    |              |                        |
    |  finalize()  |                        |
    |------------->x                        |
    x              x                        |

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

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

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

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

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

extern "C"
{
  void MySdoServiceProviderInit()
  {
    RTC::SdoServiceProviderFactory& factory
      = RTC::SdoServiceProviderFactory::instance();
    factory.addFactory(CORBA_Util::toRepositoryId<OpenRTM::MySdoService>(),
                       ::coil::Creator< ::RTC::SdoServiceProviderBase,
                       ::RTC::MySdoServiceProvider>,
                       ::coil::Destructor< ::RTC::SdoServiceProviderBase,
                       ::RTC::MySdoServiceProvider>);
  }
};

構築子と解体子

◆ ~SdoServiceProviderBase()

RTC::SdoServiceProviderBase::~SdoServiceProviderBase ( )

overridedefault

仮想デストラクタ

関数詳解

◆ finalize()

virtual void RTC::SdoServiceProviderBase::finalize ( )

pure virtual

終了処理

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

◆ getProfile()

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

pure virtual

ServiceProfile を返す

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

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

◆ init()

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

pure virtual

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

初期化関数。与えられた RTObject および ServiceProfile から、当該オブジェクトを初期化します。このサービスが ''sdo.service.provider.enabled_services'' で有効化されていれば、この関数は対応するRTCがインスタンス化された直後に呼び出されます。

ServiceProfile には以下の情報が入った状態で呼び出されます。

ServiceProfile.id: 当該サービスのIFR型
ServiceProfile.interface_type: 当該サービスのIFR型
ServiceProfile.service: 当該サービスのオブジェクト参照
ServiceProfile.properties: rtc.conf や <component>.conf 等で与えられたSDOサービス固有のオプションが渡される。 confファイル内では、''<pragma>.<module_name>.<interface_name>'' というプリフィックスをつけたオプションとして与えることができ、properties 内には、このプリフィックスを除いたオプションがkey:value形式で含まれている。

関数内では、主に properties から設定内容を読み込みサービス固有の設定等を行います。与えられた ServiceProfileの内容が不正、あるいはその他の理由で当該サービスをインスタンス化しない場合は false を返します。その場合、finalize() が呼び出されその後オブジェクトは削除されます。それ以外の場合は true を返すと、サービスオブジェクトは RTC 内に保持されます。

引数

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

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

◆ reinit()

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

pure virtual

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

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

引数

profile 新たに与えられた SDO ServiceProfile

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

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

SdoServiceProviderBase.h

公開メンバ関数

詳解

構築子と解体子

◆ ~SdoServiceProviderBase()

関数詳解

◆ finalize()

◆ getProfile()

◆ init()

◆ reinit()