OpenRTM-aist-Python 2.0.0
|
クラス | |
class | config_id |
class | nv_name |
class | org_id |
class | service_id |
公開メンバ関数 | |
def | __init__ (self, configAdmin, sdoServiceAdmin) |
def | set_device_profile (self, dProfile) |
def | add_service_profile (self, sProfile) |
def | add_organization (self, org) |
def | remove_service_profile (self, id_) |
def | remove_organization (self, organization_id) |
def | get_configuration_parameters (self) |
def | get_configuration_parameter_values (self) |
def | get_configuration_parameter_value (self, name) |
def | set_configuration_parameter (self, name, value) |
def | get_configuration_sets (self) |
def | get_configuration_set (self, config_id) |
def | set_configuration_set_values (self, configuration_set) |
def | get_active_configuration_set (self) |
def | add_configuration_set (self, configuration_set) |
def | remove_configuration_set (self, config_id) |
def | activate_configuration_set (self, config_id) |
def | getObjRef (self) |
def | getDeviceProfile (self) |
def | getServiceProfiles (self) |
def | getServiceProfile (self, id) |
def | getOrganizations (self) |
def | getUUID (self) |
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に対して処理を行う
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"で定義された属性の1つが不正か、 指定された 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 が返される。
self |
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 パラメータおよび値を返す。
※本実装では常に空のリストを返す
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameters | ( | self | ) |
[CORBA interface] 設定パラメータのリストの取得
このオペレーションは configuration parameter のリストを返す。 SDO が設定可能なパラメータを持たなければ空のリストを返す。
self |
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 を返す。
self | |
config_id | 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 を持たなければ空のリストを返す。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getDeviceProfile | ( | self | ) |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getObjRef | ( | self | ) |
オブジェクト リファレンスを取得する
対象のオブジェクトリファレンスを取得する
self |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getOrganizations | ( | self | ) |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getServiceProfile | ( | self, | |
id | |||
) |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getServiceProfiles | ( | self | ) |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.getUUID | ( | self | ) |
UUIDを生成する
UUIDを生成する
self |
def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_configuration_set | ( | self, | |
config_id | |||
) |
[CORBA interface] ConfigurationSet を削除する
ConfigurationProfile から ConfigurationSet を削除する。
self | |
config_id | 削除する ConfigurationSet の id。 |
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 そのもの。 |
InvalidParameter | config_id が null か、 指定された id で格納された ConfigurationSetが存在しないか、 指定された configuration_set内の属性の1つが不正。 |
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 | 内部的エラーが発生した。 |