クラス OpenRTM_aist.SdoConfiguration.Configuration_impl
SDO Configuration 実装クラス.
[詳細]
すべてのメンバ一覧
説明
SDO Configuration 実装クラス.
Configuration interface は Resource Data Model で定義されたデータの 追加、削除等の操作を行うためのインターフェースである。 DeviceProfile, ServiceProfile, ConfigurationProfile および Organization の変更を行うためのオペレーションを備えている。SDO の仕様ではアクセス制御 およびセキュリティに関する詳細については規定していない。
複数の設定 (Configuration) を保持することにより、容易かつ素早くある設定 を反映させることができる。事前に定義された複数の設定を ConfigurationSets および configuration profile として保持することができる。ひとつの ConfigurationSet は特定の設定に関連付けられた全プロパティ値のリストを、 ユニークID、詳細とともに持っている。これにより、各設定項目の詳細を記述し 区別することができる。Configuration interface のオペレーションはこれら ConfiguratioinSets の管理を支援する。
- ConfigurationSet: id, description, NVList から構成される1セットの設定
- ConfigurationSetList: ConfigurationSet のリスト
- Parameter: name, type, allowed_values から構成されるパラメータ定義。
- ActiveConfigurationSet: 現在有効なコンフィギュレーションの1セット。
以下、SDO仕様に明記されていないもしくは解釈がわからないため独自解釈
以下の関数は ParameterList に対して処理を行う。
以下の関数はアクティブなConfigurationSetに対する処理を行う
以下の関数はConfigurationSetListに対して処理を行う
- から:
- 0.4.0
メソッド
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.__init__ |
( |
|
self, |
|
|
|
configAdmin, |
|
|
|
sdoServiceAdmin | |
|
) |
| | |
コンストラクタ
コンストラクタ
- 引数:
-
| self | |
| configAdmin | ConfigurationSetList |
| sdoServiceAdmin | SdoServiceAdmin |
Configuration_impl(RTC.ConfigAdmin& configAdmin, RTC.SdoServiceAdmin& sdoServiceAdmin);
\var self._deviceProfile SDO DeviceProfile with mutex lock
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.activate_configuration_set |
( |
|
self, |
|
|
|
config_id | |
|
) |
| | |
[CORBA interface] ConfigurationSet のアクティブ化
ConfigurationProfile に格納された ConfigurationSet のうち一つを アクティブにする。 このオペレーションは特定の ConfigurationSet をアクティブにする。 すなわち、SDO のコンフィギュレーション・プロパティがその格納されている ConfigurationSet により設定されるプロパティの値に変更される。 指定された ConfigurationSet の値がアクティブ・コンフィギュレーション にコピーされるということを意味する。
- 引数:
-
| self | |
| config_id | アクティブ化する ConfigurationSet の id。 |
- 戻り値:
- オペレーションが成功したかどうか。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "config_id" が null である、もしくは 引数で指定された ConfigurationSet が存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_configuration_set |
( |
|
self, |
|
|
|
configuration_set | |
|
) |
| | |
[CORBA interface] ConfigurationSet を追加する
ConfigurationProfile に ConfigurationSet を追加するオペレーション。
- 引数:
-
| self | |
| configuration_set | 追加する ConfigurationSet。 |
- 戻り値:
- オペレーションが成功したかどうか。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | "configurationSet" が null か、 "configurationSet"で定義された属性の１つが不正か、 指定された configurationSet もIDが既に存在する。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_organization |
( |
|
self, |
|
|
|
org | |
|
) |
| | |
[CORBA interface] Organization の追加
このオペレーションは Organization object のリファレンスを追加する。
- 引数:
-
| self | |
| org | 追加する Organization |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InvalidParameter | 引数 "organization" が null である。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_service_profile |
( |
|
self, |
|
|
|
sProfile | |
|
) |
| | |
[CORBA interface] SDO の ServiceProfile のセット
このオペレーションはこの Configuration interface を所有する対象 SDO の ServiceProfile を追加する。もし引数の ServiceProfile の id が空であれば 新しい ID が生成されその ServiceProfile を格納する。もし id が空で なければ、SDO は同じ id を持つ ServiceProfile を検索する。 同じ id が存在しなければこの ServiceProfile を追加し、id が存在すれば 上書きをする。
(注意：最新バージョンではオペレーション名がadd_service_profile変更)
- 引数:
-
| self | |
| sProfile | 追加する ServiceProfile |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "sProfile" が nullである。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_active_configuration_set |
( |
|
self |
) |
|
[CORBA interface] アクティブな ConfigurationSet を取得する
このオペレーションは当該SDOの現在アクティブな ConfigurationSet を返す。 (もしSDOの現在の設定が予め定義された ConfigurationSet により設定されて いるならば。) ConfigurationSet は以下の場合にはアクティブではないものとみなされる。
- 現在の設定が予め定義された ConfigurationSet によりセットされていない、
- SDO の設定がアクティブになった後に変更された、
- SDO を設定する ConfigurationSet が変更された、
これらの場合には、空の ConfigurationSet が返される。
- 引数:
-
- 戻り値:
- 現在アクティブな ConfigurationSet。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameter_value |
( |
|
self, |
|
|
|
name | |
|
) |
| | |
[CORBA interface] Configuration parameter の値の取得
このオペレーションは引数 "name" で指定されたパラメータ値を返す。
※本実装では常に None を返す
- 引数:
-
| self | |
| name | 値を要求するパラメータの名前。 |
- 戻り値:
- 指定されたパラメータの値。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "name" が null である。 もしくは "name" に関連付けられたパラメータが存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameter_values |
( |
|
self |
) |
|
[CORBA interface] Configuration parameter の値のリストの取得
このオペレーションは全ての configuration パラメータおよび値を返す。
※本実装では常に空のリストを返す
- 引数:
-
- 戻り値:
- 全ての configuration パラメータと値のリスト。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameters |
( |
|
self |
) |
|
[CORBA interface] 設定パラメータのリストの取得
このオペレーションは configuration parameter のリストを返す。 SDO が設定可能なパラメータを持たなければ空のリストを返す。
- 引数:
-
- 戻り値:
- 設定を特徴付けるパラメータ定義のリスト。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_set |
( |
|
self, |
|
|
|
config_id | |
|
) |
| | |
[CORBA interface] ConfigurationSet の取得
このオペレーションは引数で指定された ConfigurationSet の ID に関連 付けられた ConfigurationSet を返す。
- 引数:
-
- 戻り値:
- 引数により指定された ConfigurationSet。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | "config_id" が null か、指定された ConfigurationSet が存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_sets |
( |
|
self |
) |
|
[CORBA interface] ConfigurationSet リストの取得
このオペレーションは ConfigurationProfile が持つ ConfigurationSet の リストを返す。 SDO が ConfigurationSet を持たなければ空のリストを返す。
- 引数:
-
- 戻り値:
- 保持している ConfigurationSet のリストの現在値。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getDeviceProfile |
( |
|
self |
) |
|
SDO の DeviceProfile を取得する.
SDO の DeviceProfile を取得する
- 引数:
-
- 戻り値:
- SDO の DeviceProfile
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getObjRef |
( |
|
self |
) |
|
オブジェクト リファレンスを取得する
対象のオブジェクトリファレンスを取得する
- 引数:
-
- 戻り値:
- オブジェクトリファレンス
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getOrganizations |
( |
|
self |
) |
|
SDO の Organization リストを取得する.
SDO の Organization リストを取得する
- 引数:
-
- 戻り値:
- SDO の Organization リスト
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getServiceProfile |
( |
|
self, |
|
|
|
id | |
|
) |
| | |
SDO の ServiceProfile を取得する.
このオペレーションは引数 "id" で指定されたSDO の ServiceProfileを返す。 "id" で指定された ServiceProfileが存在しない場合、 ServiceProfileのインスタンスを生成し返す。
- 引数:
-
| self | |
| id | ServiceProfile の識別子。 |
- 戻り値:
- 指定された SDO ServiceProfile
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getServiceProfiles |
( |
|
self |
) |
|
SDO の ServiceProfile のリストを取得する.
SDO の ServiceProfile のリストを取得する
- 引数:
-
- 戻り値:
- SDO ServiceProfileリスト
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.getUUID |
( |
|
self |
) |
|
UUIDを生成する.
UUIDを生成する
- 引数:
-
- 戻り値:
- 生成したUUID
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_configuration_set |
( |
|
self, |
|
|
|
config_id | |
|
) |
| | |
[CORBA interface] ConfigurationSet を削除する
ConfigurationProfile から ConfigurationSet を削除する。
- 引数:
-
- 戻り値:
- オペレーションが成功したかどうか。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "configurationSetID" が null である、 もしくは、引数で指定された ConfigurationSet が存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_organization |
( |
|
self, |
|
|
|
organization_id | |
|
) |
| | |
[CORBA interface] Organization の参照の削除
このオペレーションは Organization の参照を削除する。
- 引数:
-
| self | |
| organization_id | 削除する Organization の一意な id。 |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "organization_id" が null である。 もしくは "organization_id" に関連付けられた OrganizationProfile が存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_service_profile |
( |
|
self, |
|
|
|
id_ | |
|
) |
| | |
[CORBA interface] ServiceProfile の削除
このオペレーションはこの Configuration interface を持つ SDO の Service の ServiceProfile を削除する。削除する ServiceProfile は引数により指定される。
- 引数:
-
| self | |
| id_ | 削除する ServcieProfile の serviceID。 |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数 "id" が null である。もしくは "id" に 関連付けられた ServiceProfile が存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_configuration_parameter |
( |
|
self, |
|
|
|
name, |
|
|
|
value | |
|
) |
| | |
[CORBA interface] Configuration パラメータの変更
このオペレーションは "name" で指定したパラメータの値を "value" に 変更する。
※本実装では常にTrueを返す
- 引数:
-
| self | |
| name | 変更対象パラメータの名前。 |
| value | 変更対象パラメータの新しい値。 |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| InvalidParameter | 引数( "name"もしくは"value") が null である。 もしくは "name" に関連付けられたパラメータが存在しない。 |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_configuration_set_values |
( |
|
self, |
|
|
|
configuration_set | |
|
) |
| | |
[CORBA interface] ConfigurationSet をセットする
このオペレーションは指定された id の ConfigurationSet を更新する。
- 引数:
-
| self | |
| configuration_set | 変更する ConfigurationSet そのもの。 |
- 戻り値:
- ConfigurationSet が正常に更新できた場合は true。 そうでなければ false を返す。
- 例外:
-
| InvalidParameter | config_id が null か、 指定された id で格納された ConfigurationSetが存在しないか、 指定された configuration_set内の属性の１つが不正。 |
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InternalError | 内部的エラーが発生した。 |
| def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_device_profile |
( |
|
self, |
|
|
|
dProfile | |
|
) |
| | |
[CORBA interface] SDO の DeviceProfile のセット
このオペレーションは SDO の DeviceProfile をセットする。SDO が DeviceProfile を保持していない場合は新たな DeviceProfile を生成し、 DeviceProfile をすでに保持している場合は既存のものと置き換える。
- 引数:
-
| self | |
| dProfile | SDO に関連付けられる DeviceProfile。 |
- 戻り値:
- オペレーションが成功したかどうかを返す。
- 例外:
-
| SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
| NotAvailable | SDOは存在するが応答がない。 |
| InvalidParameter | 引数 "dProfile" が null である。 |
| InternalError | 内部的エラーが発生した。 |
このクラスの説明は次のファイルから生成されました:
