メインページ | ネームスペース一覧 | クラス階層 | 構成 | ファイル一覧 | 構成メンバ | ファイルメンバ

クラス Configuration_impl

SDO Configuration 実装クラス. [詳細]

すべてのメンバ一覧

Public メソッド

 __init__ (configsets)
 set_device_profile (dProfile)
 [CORBA interface] SDO の DeviceProfile をセットする
 set_service_profile (sProfile)
 [CORBA interface] SDO の ServiceProfile のセット
 add_organization (org)
 [CORBA interface] Organization の追加
 remove_service_profile (id_)
 [CORBA interface] ServiceProfile の削除
 remove_organization (organization_id)
 [CORBA interface] Organization の参照の削除
 get_configuration_parameters ()
 [CORBA interface] 設定パラメータのリストの取得
 get_configuration_parameter_values ()
 [CORBA interface] Configuration parameter の値のリストの取得
 get_configuration_parameter_value (name)
 [CORBA interface] Configuration parameter の値の取得
 set_configuration_parameter (name, value)
 [CORBA interface] Configuration パラメータの変更
 get_configuration_sets ()
 [CORBA interface] ConfigurationSet リストの取得
 get_configuration_set (config_id)
 [CORBA interface] ConfigurationSet の取得
 set_configuration_set_values (config_id, configuration_set)
 [CORBA interface] ConfigurationSet をセットする
 get_active_configuration_set ()
 [CORBA interface] アクティブな ConfigurationSet を取得する
 add_configuration_set (configuration_set)
 [CORBA interface] ConfigurationSet を追加する
 remove_configuration_set (config_id)
 [CORBA interface] ConfigurationSet を削除する
 activate_configuration_set (config_id)
 [CORBA interface] ConfigurationSet のアクティブ化
 getObjRef ()
 getDeviceProfile ()
 getServiceProfiles ()
 getServiceProfile (id)
 getOrganizations ()
 getUUID ()

構成

class  config_id
class  nv_name
 アクティブな ConfigurationSet [詳細]
class  org_id
class  service_id


説明

SDO Configuration 実装クラス.

Configuration interface は Resource Data Model で定義されたデータの 追加、削除等の操作を行うためのインターフェースである。 DeviceProfile, ServiceProfile, ConfigurationProfile および Organization の変更を行うためのオペレーションを備えている。SDO の仕様ではアクセス制御 およびセキュリティに関する詳細については規定していない。

複数の設定 (Configuration) を保持することにより、容易かつ素早くある設定 を反映させることができる。事前に定義された複数の設定を ConfigurationSets および configuration profile として保持することができる。ひとつの ConfigurationSet は特定の設定に関連付けられた全プロパティ値のリストを、 ユニークID、詳細とともに持っている。これにより、各設定項目の詳細を記述し 区別することができる。Configuration interface のオペレーションはこれら ConfiguratioinSets の管理を支援する。

以下、SDO仕様に明記されていないもしくは解釈がわからないため独自解釈

以下の関数は ParameterList に対して処理を行う。

以下の関数はアクティブなConfigurationSetに対する処理を行う

以下の関数はConfigurationSetListに対して処理を行う


関数

Configuration_impl::__init__ configsets   ) 
 

Configuration_impl::activate_configuration_set config_id   ) 
 

[CORBA interface] ConfigurationSet のアクティブ化

ConfigurationProfile に格納された ConfigurationSet のうち一つを アクティブにする。 このオペレーションは特定の ConfigurationSet をアクティブにする。 すなわち、SDO のコンフィギュレーション・プロパティがその格納されている ConfigurationSet により設定されるプロパティの値に変更される。 指定された ConfigurationSet の値がアクティブ・コンフィギュレーション にコピーされるということを意味する。

引数:
config_id アクティブ化する ConfigurationSet の id。
戻り値:
オペレーションが成功したかどうか。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter 引数 "config_id" が null である、もしくは 引数で指定された ConfigurationSet が存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::add_configuration_set configuration_set   ) 
 

[CORBA interface] ConfigurationSet を追加する

ConfigurationProfile に ConfigurationSet を追加するオペレーション。

引数:
configuration_set 追加される ConfigurationSet。
戻り値:
オペレーションが成功したかどうか。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::add_organization org   ) 
 

[CORBA interface] Organization の追加

このオペレーションは Organization object のリファレンスを追加する。

引数:
org 追加する Organization
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InvalidParameter 引数 "organization" が null である。
InternalError 内部的エラーが発生した。

Configuration_impl::get_active_configuration_set  ) 
 

[CORBA interface] アクティブな ConfigurationSet を取得する

このオペレーションは当該SDOの現在アクティブな ConfigurationSet を返す。 (もしSDOの現在の設定が予め定義された ConfigurationSet により設定されて いるならば。) ConfigurationSet は以下の場合にはアクティブではないものとみなされる。

  • 現在の設定が予め定義された ConfigurationSet によりセットされていない、
  • SDO の設定がアクティブになった後に変更された、
  • SDO を設定する ConfigurationSet が変更された、

これらの場合には、空の ConfigurationSet が返される。

戻り値:
現在アクティブな ConfigurationSet。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::get_configuration_parameter_value name   ) 
 

[CORBA interface] Configuration parameter の値の取得

このオペレーションは引数 "name" で指定されたパラメータ値を返す。

引数:
name 値を要求するパラメータの名前。
戻り値:
指定されたパラメータの値。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::get_configuration_parameter_values  ) 
 

[CORBA interface] Configuration parameter の値のリストの取得

このオペレーションは configuration パラメータおよび値を返す。

戻り値:
全ての configuration パラメータと値のリスト。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::get_configuration_parameters  ) 
 

[CORBA interface] 設定パラメータのリストの取得

このオペレーションは configuration parameter のリストを返す。 SDO が設定可能なパラメータを持たなければ空のリストを返す。

戻り値:
設定を特徴付けるパラメータ定義のリスト。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::get_configuration_set config_id   ) 
 

[CORBA interface] ConfigurationSet の取得

このオペレーションは引数で指定された ConfigurationSet の ID に関連 付けられた ConfigurationSet を返す。

引数:
config_id ConfigurationSet の識別子。
戻り値:
引数により指定された ConfigurationSet。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter "config_id" が null か、指定された ConfigurationSet が存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::get_configuration_sets  ) 
 

[CORBA interface] ConfigurationSet リストの取得

このオペレーションは ConfigurationProfile が持つ ConfigurationSet の リストを返す。 SDO が ConfigurationSet を持たなければ空のリストを返す。

戻り値:
保持している ConfigurationSet のリストの現在値。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::getDeviceProfile  ) 
 

Configuration_impl::getObjRef  ) 
 

Configuration_impl::getOrganizations  ) 
 

Configuration_impl::getServiceProfile id   ) 
 

Configuration_impl::getServiceProfiles  ) 
 

Configuration_impl::getUUID  ) 
 

Configuration_impl::remove_configuration_set config_id   ) 
 

[CORBA interface] ConfigurationSet を削除する

ConfigurationProfile から ConfigurationSet を削除する。

引数:
configu_id 削除する ConfigurationSet の id。
戻り値:
オペレーションが成功したかどうか。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter 引数 "configurationSetID" が null である、 もしくは、引数で指定された ConfigurationSet が存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::remove_organization organization_id   ) 
 

[CORBA interface] Organization の参照の削除

このオペレーションは Organization の参照を削除する。

引数:
organization_id 削除する Organization の一意な id。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter 
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::remove_service_profile id_   ) 
 

[CORBA interface] ServiceProfile の削除

このオペレーションはこの Configuration interface を持つ SDO の Service の ServiceProfile を削除する。削除する ServiceProfile は引数により指定される。

引数:
id 削除する ServcieProfile の serviceID。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter 引数 "id" が null である。もしくは "id" に 関連付けられた ServiceProfile が存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::set_configuration_parameter name  ,
value 
 

[CORBA interface] Configuration パラメータの変更

このオペレーションは "name" で指定したパラメータの値を "value" に 変更する。

引数:
name 変更したいパラメータの名前。
value 変更したいパラメータの値。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::set_configuration_set_values config_id  ,
configuration_set 
 

[CORBA interface] ConfigurationSet をセットする

このオペレーションは指定された id の ConfigurationSet を更新する。

引数:
configu_id 変更する ConfigurationSet の ID。
configuration_set 変更する ConfigurationSet そのもの。
戻り値:
ConfigurationSet が正常に更新できた場合は true。 そうでなければ false を返す。
例外:
InvalidParameter config_id が null か ConfigurationSet
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

Configuration_impl::set_device_profile dProfile   ) 
 

[CORBA interface] SDO の DeviceProfile をセットする

このオペレーションは SDO の DeviceProfile をセットする。SDO が DeviceProfile を保持している場合は新たな DeviceProfile を生成し、 DeviceProfile をすでに保持している場合は既存のものと置き換える。

引数:
dProfile SDO に関連付けられる DeviceProfile。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InvalidParameter 引数 "dProfile" が null である。
InternalError 内部的エラーが発生した。

Configuration_impl::set_service_profile sProfile   ) 
 

[CORBA interface] SDO の ServiceProfile のセット

このオペレーションはこの Configuration interface を所有する対象 SDO の ServiceProfile を設定する。もし引数の ServiceProfile の id が空であれば 新しい ID が生成されその ServiceProfile を格納する。もし id が空で なければ、SDO は同じ id を持つ ServiceProfile を検索する。 同じ id が存在しなければこの ServiceProfile を追加し、id が存在すれば 上書きをする。

引数:
sProfile 追加する ServiceProfile
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists ターゲットのSDOが存在しない。
InvalidParameter 引数 "sProfile" が nullである。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。


このクラスの説明は次のファイルから生成されました:
OpenRTMに対してMon Oct 29 15:51:37 2007に生成されました。  doxygen 1.4.3