OpenRTM_aist.SdoOrganization.Organization_impl クラス

SDO Organization 実装クラス [詳解]

OpenRTM_aist.SdoOrganization.Organization_impl の継承関係図

クラス
class	nv_name
	NVList検索用functor. [詳解]
class	sdo_id
	SDO検索用functor. [詳解]

公開メンバ関数
def	__init__ (self, sdo)
	コンストラクタ [詳解]
def	get_organization_id (self)
	[CORBA interface] Organization ID を取得する [詳解]
def	get_organization_property (self)
	[CORBA interface] OrganizationProperty の取得 [詳解]
def	get_organization_property_value (self, name)
	[CORBA interface] OrganizationProperty の特定の値の取得 [詳解]
def	add_organization_property (self, org_property)
	[CORBA interface] OrganizationProperty のセット [詳解]
def	set_organization_property_value (self, name, value)
	[CORBA interface] OrganizationProperty の値のセット [詳解]
def	remove_organization_property (self, name)
	[CORBA interface] OrganizationProperty の削除 [詳解]
def	get_owner (self)
	[CORBA interface] Organization のオーナーを取得する [詳解]
def	set_owner (self, sdo)
	[CORBA interface] Organization にオーナーをセットする [詳解]
def	get_members (self)
	[CORBA interface] Organization のメンバーを取得する [詳解]
def	set_members (self, sdos)
	[CORBA interface] SDO の セット [詳解]
def	add_members (self, sdo_list)
	[CORBA interface] SDO メンバーの追加 [詳解]
def	remove_member (self, id)
	[CORBA interface] SDO メンバーの削除 [詳解]
def	get_dependency (self)
	[CORBA interface] Organization の DependencyType を取得 [詳解]
def	set_dependency (self, dependency)
	[CORBA interface] Organization の DependencyType をセットする [詳解]

詳解

SDO Organization 実装クラス

Organization interface は Resource Data Model で定義されたデータの 追加、削除等の操作を行うためのインターフェースである。

から

0.4.0

構築子と解体子

def OpenRTM_aist.SdoOrganization.Organization_impl.__init__	(		self,
			sdo
	)

コンストラクタ

コンストラクタ

メソッド詳解

def OpenRTM_aist.SdoOrganization.Organization_impl.add_members	(		self,
			sdo_list
	)

[CORBA interface] SDO メンバーの追加

Organization にメンバーとして SDO を追加する。 引数 "sdo" に追加するメンバー SDO を指定する。

引数

self
sdo_list	Organization に追加される SDO のリスト。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "sdo" が nullである。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.add_organization_property	(		self,
			org_property
	)

[CORBA interface] OrganizationProperty のセット

※ SDO Specification の PIM 記述とオペレーション名が異なる。 ※ addOrganizationProperty に対応か？
OrganizationProperty を Organization に追加するオペレーション。 OrganizationProperty は Organization のプロパティ記述である。

引数

self
org_property	セットする OrganizationProperty

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	"org_property" が null。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_dependency

(

self

)

[CORBA interface] Organization の DependencyType を取得

Organization の関係を表す "DependencyType" を返す。

引数

self

戻り値

Organizaton の依存関係 DependencyType を返す。 DependencyType は OMG SDO 仕様の Section 2.2.2 2-3 ページの "Data Structures Used by Resource Data Model" を参照。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_members

(

self

)

[CORBA interface] Organization のメンバーを取得する

Organization のメンバーの SDO のリストを返す。 メンバーが存在しなければ空のリストを返す。

引数

self

戻り値

Organization に含まれるメンバー SDO のリスト。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_id

(

self

)

[CORBA interface] Organization ID を取得する

Organization の ID を返すオペレーション。

引数

self

戻り値

Resource Data Model で定義された Organization ID。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_property

(

self

)

[CORBA interface] OrganizationProperty の取得

Organization が所有する OrganizationProperty を返すオペレーション。 Organization がプロパティを持たなければ空のリストを返す。

引数

self

戻り値

Organization のプロパティのリスト。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_property_value	(		self,
			name
	)

[CORBA interface] OrganizationProperty の特定の値の取得

OrganizationProperty の指定された値を返すオペレーション。 引数 "name" で指定されたプロパティの値を返す。

引数

self
name	値を返すプロパティの名前。

戻り値

引数 "name" で指定されたプロパティの値。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "namne" で指定されたプロパティが 存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.get_owner

(

self

)

[CORBA interface] Organization のオーナーを取得する

この Organization のオーナーへの参照を返す。

引数

self

戻り値

オーナーオブジェクトへの参照。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.remove_member	(		self,
			id
	)

[CORBA interface] SDO メンバーの削除

Organization から引数で指定された "id" の SDO を削除する。

引数

self
id	削除する SDO の id。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "id" が null もしくは存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.remove_organization_property	(		self,
			name
	)

[CORBA interface] OrganizationProperty の削除

OrganizationProperty の NVList から特定のプロパティを削除する。 削除されるプロパティの名前は引数 "name" により指定される。

引数

self
name	削除するプロパティの名前。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "name" で指定されたプロパティは 存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.set_dependency	(		self,
			dependency
	)

[CORBA interface] Organization の DependencyType をセットする

Organization の依存関係 "DependencyType" をセットする。 引数 "dependencty" により依存関係を与える。

引数

self
dependency	Organization の依存関係を表す DependencyType。 DependencyType は OMG SDO 仕様の Section 2.2.2、2-3 ページの "Data Structures Used by Resource Data Model" を参照。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "sProfile" が nullである。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.set_members	(		self,
			sdos
	)

[CORBA interface] SDO の セット

SDO のリストを Organization のメンバーとしてセットする。 Organization がすでにメンバーの SDO を管理している場合は、 与えられた SDO のリストに置き換える。

引数

self
sdos	メンバーの SDO。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "SDOList" が nullである、もしくは 引数に指定された "SDOList" が存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.set_organization_property_value	(		self,
			name,
			value
	)

[CORBA interface] OrganizationProperty の値のセット

OrganizationProperty の NVList に name と value のセットを追加もしくは 更新するオペレーション。name と value は引数 "name" と "value" により 指定する。

引数

self
name	追加・更新されるプロパティの名前。
value	追加・更新されるプロパティの値。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "name" で指定されたプロパティは 存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

def OpenRTM_aist.SdoOrganization.Organization_impl.set_owner	(		self,
			sdo
	)

[CORBA interface] Organization にオーナーをセットする

Organization に対して SDOSystemElement をオーナーとしてセットする。 引数 "sdo" にセットする SDOSystemElement を指定する。

引数

self
sdo	オーナーオブジェクトの参照。

戻り値

オペレーションが成功したかどうかを返す。

例外

SDONotExists	ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
InvalidParameter	引数 "sdo" が nullである、もしくは、 "sdo" が存在しない。
NotAvailable	SDOは存在するが応答がない。
InternalError	内部的エラーが発生した。

---

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

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