SdoServiceProvider　基底クラス [詳解]

OpenRTM_aist.SdoServiceProviderBase.SdoServiceProviderBase の継承関係図

公開メンバ関数
def	__del__ (self)
	仮想デストラクタ

def	init (self, rtobj, profile)
	コンシューマクラスの初期化関数 [詳解]

def	reinit (self, profile)
	コンシューマクラスの再初期化関数 [詳解]

def	getProfile (self)
	ServiceProfile を返す [詳解]

def	finalize (self)
	終了処理 [詳解]

詳解

SdoServiceProvider　基底クラス

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

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

マネージャに対してロードされるとモジュール初期化関数によりオブジェクトファクトリが、SdoServiceProviderFactory に対して登録される。登録のキーにはサービスインターフェースの IFR (interface repository) ID が利用され、これによりサービスが区別される。
rtc.conf等のコンフィギュレーション指定により、有効化することが指定されているサービスインプロバイダは、RTCの起動と同時にインスタンス化される。
インスタンス化後、初期化関数 init() が呼ばれる。引数には当該サービスのためのコンフィギュレーションオプションが 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.py
エントリポイント関数名: MySdoServiceProviderInit()

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

   def MySdoServiceProviderInit(mgr=None):
     factory = OpenRTM_aist.SdoServiceProviderFactory.instance()
     factory.addFactory(OpenRTM.MySdoService._NP_RepositoryId,
                        MySdoServiceProvider,
                        OpenRTM_aist.Delete)
     return

メソッド詳解

def OpenRTM_aist.SdoServiceProviderBase.SdoServiceProviderBase.finalize ( self )

終了処理

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

virtual void finalize() = 0;

def OpenRTM_aist.SdoServiceProviderBase.SdoServiceProviderBase.getProfile ( self )

ServiceProfile を返す

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

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

virtual const SDOPackage::ServiceProfile& getProfile() const = 0;

def OpenRTM_aist.SdoServiceProviderBase.SdoServiceProviderBase.init	(	self,
		rtobj,
		profile
	)

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

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

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

引数

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

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

virtual bool init(RTObject_impl& rtobj, const SDOPackage::ServiceProfile& profile) = 0;

def OpenRTM_aist.SdoServiceProviderBase.SdoServiceProviderBase.reinit	(	self,
		profile
	)

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

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

引数

profile 新たに与えられた SDO ServiceProfile

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

virtual bool reinit(const SDOPackage::ServiceProfile& profile) = 0;

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

/tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/SdoServiceProviderBase.py

公開メンバ関数

詳解

メソッド詳解