jp.go.aist.rtm.RTC.SDOPackage
クラス Organization_impl

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.SDOPackage.Organization_impl

public class Organization_impl
extends java.lang.Object

SDO Organizationの実装クラスです。


入れ子のクラスの概要
(package private)  class Organization_impl.nv_name
          Organization プロパティ検索用ヘルパークラス
 
フィールドの概要
protected  DependencyType m_dependency
          依存関係のタイプ
Owner と member の依存関係を指定する属性。
protected  SDO[] m_memberList
          Organization に関連付けられた SDO メンバのリスト
(package private)  OrganizationProperty m_orgProperty
          Organization プロパティ
OrganizationProperty は Organization のプロパティ情報を保持します。
protected  java.lang.String m_pId
          Organization の識別子
protected  SDOSystemElement m_varOwner
          Organization の owner
 
コンストラクタの概要
Organization_impl()
          デフォルトコンストラクタです。
 
メソッドの概要
 boolean add_members(SDO[] sdo_list)
          [CORBA interface] SDO メンバーを追加します。
 DependencyType get_dependency()
          [CORBA interface] Organization の DependencyType を取得します。
 SDO[] get_members()
          [CORBA interface] Organization のメンバーを取得します。
 java.lang.String get_organization_id()
          [CORBA interface] Organization ID を取得します。
 org.omg.CORBA.Any get_organization_property_value(java.lang.String name)
          [CORBA interface] OrganizationProperty の特定の値を取得します。
 OrganizationProperty get_organization_property()
          [CORBA interface] OrganizationProperty を取得します。
 SDOSystemElement get_owner()
          [CORBA interface] Organization のオーナーを取得します。
 boolean remove_member(java.lang.String id)
          [CORBA interface] SDO メンバーを削除します。
 boolean remove_organization_property(java.lang.String name)
          [CORBA interface] OrganizationProperty を削除します。
 boolean set_dependency(DependencyType dependency)
          [CORBA interface] Organization の DependencyType を設定します。
 boolean set_members(SDO[] sdos)
          [CORBA interface] SDO の メンバー を設定します。
 boolean set_organization_property_value(java.lang.String name, org.omg.CORBA.Any value)
          [CORBA interface] OrganizationProperty の値を設定します。
 boolean set_organization_property(OrganizationProperty organization_property)
          [CORBA interface] OrganizationProperty を設定します。
 boolean set_owner(SDOSystemElement sdo)
          [CORBA interface] Organization にオーナーを設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

m_pId

protected java.lang.String m_pId

Organization の識別子


m_memberList

protected SDO[] m_memberList

Organization に関連付けられた SDO メンバのリスト


m_varOwner

protected SDOSystemElement m_varOwner

Organization の owner


m_dependency

protected DependencyType m_dependency

依存関係のタイプ
Owner と member の依存関係を指定する属性。 Organization は以下のトポロジパターンを表現することができます。

  1. owenr が member を管理する階層的構造。この場合 DependencyType は OWNという値を持つ。
  2. members が owner を管理する逆向きの階層的構造。 この場合はDependencyType は OWNER という値を持つ。
  3. owner と member に依存関係がないフラットな構造。 この場合はDependencyType は NO_DEPENDENCY という値を持つ。

SDO および SDOSystemElement のサブクラスは Organization の owner として 振舞うことが出来ます。SDO が owner の場合にはOrganization は上記の いずれかのトポロジーパターンをとります。

  1. Organization が 1. のトポロジーパターンを持つ場合、唯一つの owner SDOは member SDO を制御します。 たとえば、エアコン(owner)は、温度センサ(member)、湿度センサ(member)、風量制御器(member)を制御します。
  2. Organization が 2. のトポロジを持つ場合は、複数の SDO member が唯一のSDO owner を共有します。 たとえば、アンプ(owner)はいくつかのAVコンポーネント(member)から共有されます。
  3. SDO ではない SDOSystemElement のサブクラスが owner の場合、以下のようなトポロジー例が考えられます。
    1. User(owner)-SDO(member): ユーザ(owner) は一つ以上の SDO(member)を管理します。 これは上記トポロジパタン1.にあたります。
    2. Location(owner)-SDO(members): 一つ以上の SDO(member) が特定の場所 = location(owner) で動作している場合、Organization のトポロジパターン は 3. の場合になります。たとえば、複数の PDA がある部屋にあり、互いに同等 な関係であり相互に通信可能な場合はこれにあたります。


m_orgProperty

OrganizationProperty m_orgProperty

Organization プロパティ
OrganizationProperty は Organization のプロパティ情報を保持します。 一つの Organization は0個もしくは1個の OrganizationProperty をもちます。

コンストラクタの詳細

Organization_impl

public Organization_impl()

デフォルトコンストラクタです。

メソッドの詳細

get_organization_id

public java.lang.String get_organization_id()
                                     throws InvalidParameter,
                                            NotAvailable,
                                            InternalError

[CORBA interface] Organization ID を取得します。

戻り値:
Resource Data Model で定義された Organization ID
例外:
SDONotExists - ターゲットのSDOが存在しない
NotAvailable - SDOは存在するが応答がない
InternalError - 内部的エラーが発生した
InvalidParameter

get_organization_property

public OrganizationProperty get_organization_property()
                                               throws NotAvailable,
                                                      InternalError

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

戻り値:
Organization のプロパティのリスト
例外:
SDONotExists - ターゲットのSDOが存在しない
NotAvailable - SDOは存在するが応答がない
InternalError - 内部的エラーが発生した

get_organization_property_value

public org.omg.CORBA.Any get_organization_property_value(java.lang.String name)
                                                  throws InvalidParameter,
                                                         NotAvailable,
                                                         InternalError

[CORBA interface] OrganizationProperty の特定の値を取得します。
OrganizationProperty の指定された値を返すオペレーション。 引数 "name" で指定されたプロパティの値を返します。

パラメータ:
name - 値を返すプロパティの名前
戻り値:
引数 "name" で指定されたプロパティの値
例外:
SDONotExists - ターゲットのSDOが存在しない
InvalidParameter - 引数 "namne" で指定されたプロパティが 存在しない
NotAvailable - SDOは存在するが応答がない
InternalError - 内部的エラーが発生した

set_organization_property

public boolean set_organization_property(OrganizationProperty organization_property)
                                  throws InvalidParameter,
                                         NotAvailable,
                                         InternalError

[CORBA interface] OrganizationProperty を設定します。
OrganizationProperty を Organization に追加するオペレーション。 OrganizationProperty は Organization のプロパティ記述です。

パラメータ:
organization_property - セットする OrganizationProperty
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists - ターゲットのSDOが存在しない。
InvalidParameter - "org_property" が null。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_organization_property_value

public boolean set_organization_property_value(java.lang.String name,
                                               org.omg.CORBA.Any value)
                                        throws InvalidParameter,
                                               NotAvailable,
                                               InternalError

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

パラメータ:
name - 追加・更新されるプロパティの名前。
value - 追加・更新されるプロパティの値。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists - ターゲットのSDOが存在しない。
InvalidParameter - 引数 "name" で指定されたプロパティは 存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

remove_organization_property

public boolean remove_organization_property(java.lang.String name)
                                     throws InvalidParameter,
                                            NotAvailable,
                                            InternalError

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

パラメータ:
name - 削除するプロパティの名前。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists - ターゲットのSDOが存在しない。
InvalidParameter - 引数 "name" で指定されたプロパティは 存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_owner

public SDOSystemElement get_owner()
                           throws NotAvailable,
                                  InternalError

[CORBA interface] Organization のオーナーを取得します。
この Organization のオーナーへの参照を返します。

戻り値:
オーナーオブジェクトへの参照。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_owner

public boolean set_owner(SDOSystemElement sdo)
                  throws InvalidParameter,
                         NotAvailable,
                         InternalError

[CORBA interface] Organization にオーナーを設定します。
Organization に対して SDOSystemElement をオーナーとしてセットします。 引数 "sdo" にセットする SDOSystemElement を指定します。

パラメータ:
sdo - オーナーオブジェクトの参照。
戻り値:
オペレーションが成功したかどうかを返す。
例外:
SDONotExists - ターゲットのSDOが存在しない。
InvalidParameter - 引数 "sdo" が nullである、もしくは、 "sdo" が存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_members

public SDO[] get_members()
                  throws NotAvailable,
                         InternalError

[CORBA interface] Organization のメンバーを取得します。
Organization のメンバーの SDO のリストを返します。 メンバーが存在しなければ空のリストを返します。

戻り値:
Organization に含まれるメンバー SDO のリスト。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_members

public boolean set_members(SDO[] sdos)
                    throws InvalidParameter,
                           NotAvailable,
                           InternalError

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

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

add_members

public boolean add_members(SDO[] sdo_list)
                    throws InvalidParameter,
                           NotAvailable,
                           InternalError

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

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

remove_member

public boolean remove_member(java.lang.String id)
                      throws InvalidParameter,
                             NotAvailable,
                             InternalError

[CORBA interface] SDO メンバーを削除します。
Organization から引数で指定された "id" の SDO を削除します。

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

get_dependency

public DependencyType get_dependency()
                              throws NotAvailable,
                                     InternalError

[CORBA interface] Organization の DependencyType を取得します。
Organization の関係を表す "DependencyType" を返します。

戻り値:
Organizaton の依存関係 DependencyType を返します。 DependencyType は OMG SDO 仕様の Section 2.2.2 2-3 ページの "Data Structures Used by Resource Data Model" を参照。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

set_dependency

public boolean set_dependency(DependencyType dependency)
                       throws NotAvailable,
                              InternalError

[CORBA interface] Organization の DependencyType を設定します。
Organization の依存関係 "DependencyType" をセットします。 引数 "dependencty" により依存関係を与えます。

パラメータ:
dependency - Organization の依存関係を表す DependencyType。 DependencyType は OMG SDO 仕様の Section 2.2.2、2-3 ページの "Data Structures Used by Resource Data Model" を参照。
戻り値:
オペレーションが成功したかどうかを返します。
例外:
SDONotExists - ターゲットのSDOが存在しない。
InvalidParameter - 引数 "sProfile" が nullである。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。