jp.go.aist.rtm.RTC.SDOPackage

Class Organization_impl

java.lang.Object

org.omg.PortableServer.Servant

_SDOPackage.OrganizationPOA

jp.go.aist.rtm.RTC.SDOPackage.Organization_impl

All Implemented Interfaces:

OrganizationOperations, org.omg.CORBA.portable.InvokeHandler

Direct Known Subclasses:

PeriodicECOrganization

public class Organization_impl
extends OrganizationPOA

Implementation class of Organization

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Organization_impl.nv_name

Field Summary

Fields

Modifier and Type	Field and Description
protected DependencyType	m_dependency Dependency type
protected SDO[]	m_memberList
protected Organization	m_objref
(package private) OrganizationProperty	m_orgProperty
protected java.lang.String	m_pId
protected SDOSystemElement	m_varOwner
protected Logbuf	rtcout

Constructor Summary

Constructors

Constructor and Description
Organization_impl() Constructor
Organization_impl(SDOSystemElement sdo) constructor

Method Summary

Modifier and Type	Method and Description
Organization	_this() _this
boolean	add_members(SDO[] sdo_list) [CORBA interface] Add the member SDOs
boolean	add_organization_property(OrganizationProperty organization_property) [CORBA interface] Set OrganizationProperty
DependencyType	get_dependency() [CORBA interface] Get the DependencyType of the Organization
SDO[]	get_members() [CORBA interface] Get the member list of the Organization
java.lang.String	get_organization_id() [CORBA interface] Gets Organization ID
org.omg.CORBA.Any	get_organization_property_value(java.lang.String name) [CORBA interface] Gets a specific value of OrganizationProperty
OrganizationProperty	get_organization_property() [CORBA interface] Gets OrganizationProperty
SDOSystemElement	get_owner() [CORBA interface] Get the owner of Organization
Organization	getObjRef() {@.en Gets the object.
boolean	remove_member(java.lang.String id) [CORBA interface] Remove member SDO from Organization
boolean	remove_organization_property(java.lang.String name) [CORBA interface] Deletes OrganizationProperty
boolean	set_dependency(DependencyType dependency) [CORBA interface] Set the DependencyType of the Organization
boolean	set_members(SDO[] sdos) [CORBA interface] Set SDO
boolean	set_organization_property_value(java.lang.String name, org.omg.CORBA.Any value)
boolean	set_organization_property(OrganizationProperty organization_property) [CORBA interface] Sets OrganizationProperty
boolean	set_owner(SDOSystemElement sdo) [CORBA interface] Set the owner to the Organization

Methods inherited from class _SDOPackage.OrganizationPOA

_all_interfaces, _invoke, _this

Methods inherited from class org.omg.PortableServer.Servant

_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_objref

protected Organization m_objref

m_pId

protected java.lang.String m_pId

m_memberList

protected SDO[] m_memberList

m_varOwner

protected SDOSystemElement m_varOwner

m_dependency

protected DependencyType m_dependency

Dependency type

This attribute specifies the dependency relation between the owner and members of the organization. Organization is used to form the following three patterns of topology. -# Hierarchical organization, which indicates owner supervises members. In this case, DependencyType should hold OWN value (see description of DependencyType on previous pages). -# Reversely hierarchical organization, which indicates members supervise owner. In this case, DependencyType should hold OWNED value (see description of DependencyType on previous pages). -# Flat organization, which indicates no dependency exists. In this case, DependencyType should hold NO_DEPENDENCY value (see description of DependencyType on previous pages). Both an SDO and another subclass of SDOSystemElement can act as owner of an Organization. When an SDO is an owner, Organization can represent any of the above three topology patterns. - When an Organization represents topology pattern (1), an SDO (owner) controls one or more SDOs (members). For example, air conditioner (owner) controls a temperature sensor (member), humidity sensor (member), and wind flow controller (member). - When an Organization represents topology pattern (2), multiple SDOs(members) share an SDO (owner). For example, an amplifier (owner) is shared by several AV components (members) in an AV stereo. - When a subclass of SDOSystemElement, which is not an SDO is an owner examples of the topology are as follows. -- User (owner)-SDO (members): When a user (owner) supervises one or more SDOs (members), the organization represents topology pattern 1. -- Location (owner)-SDO (members): When one or more SDOs (members) are operating in a specific location (owner), the organization represents topology pattern 3. For example, multiple PDAs in the same place (e.g., a room) have equal relationships among them to communicate with each other.

m_orgProperty

OrganizationProperty m_orgProperty

member:property NVList

rtcout

protected Logbuf rtcout

Constructor Detail

Organization_impl

public Organization_impl()

Constructor

Organization_impl

public Organization_impl(SDOSystemElement sdo)

constructor

Parameters:

sdo - Owner object

Method Detail

_this

public Organization _this()

_this

Overrides:

_this in class OrganizationPOA

Returns:

a CORBA object reference

get_organization_id

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

[CORBA interface] Gets Organization ID

Returns:

Organization ID defined by Data Model

Throws:

SDONotExists - SDO of the target doesn't exist.

NotAvailable - There is no response though SDO exists.

InternalError - An internal error occurred.

InvalidParameter

get_organization_property

public OrganizationProperty get_organization_property()
                                               throws NotAvailable,
                                                      InternalError

[CORBA interface] Gets OrganizationProperty

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

Returns:

Property list of Organization

Throws:

SDONotExists - SDO of the target doesn't exist.

NotAvailable - There is no response though SDO exists.

InternalError - An internal error occurred.

get_organization_property_value

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

[CORBA interface] Gets a specific value of OrganizationProperty

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

Parameters:

name - name of Property

Returns:

value of Property

Throws:

SDONotExists - SDO of the target doesn't exist.

InvalidParameter - The specified property doesn't exist.

NotAvailable - There is no response though SDO exists.

InternalError - An internal error occurred.

set_organization_property

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

[CORBA interface] Sets OrganizationProperty

OrganizationProperty を Organization に追加するオペレーション。 OrganizationProperty は Organization のプロパティ記述。

Parameters:

organization_property - OrganizationProperty

Returns:

The success is true.

Throws:

SDONotExists - SDO of the target doesn't exist.

InvalidParameter - "org_property" is null

NotAvailable - There is no response though SDO exists.

InternalError - An internal error occurred.

add_organization_property

public boolean add_organization_property(OrganizationProperty organization_property)
                                  throws org.omg.CORBA.SystemException,
                                         InvalidParameter,
                                         NotAvailable,
                                         InternalError

[CORBA interface] Set OrganizationProperty

Note: The PIM description of SDO Specification differs from the operation name. Note: Does this operation correspond to addOrganizationProperty? This operation adds the OrganizationProperty to an Organization. The OrganizationProperty is the property description of an Organization.

Parameters:

organization_property - The type of organization to be added.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)

InvalidParameter - The argument "organizationProperty" is null.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

org.omg.CORBA.SystemException

set_organization_property_value

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

Parameters:

name - name of Property

value - value of Property

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The specified property doesn't exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - An internal error occurred.

remove_organization_property

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

[CORBA interface] Deletes OrganizationProperty

This operation removes a property of Organization from NVList of the OrganizationProperty. The property to be removed is specified by argument "name."

Parameters:

name - The name of the property to be removed.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The property that is specified by argument "name" does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

get_owner

public SDOSystemElement get_owner()
                           throws NotAvailable,
                                  InternalError

[CORBA interface] Get the owner of Organization

This operation returns the SDOSystemElement that is owner of the Organization.

Returns:

Reference of owner object.

Throws:

SDONotExists - The target SDO does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

set_owner

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

[CORBA interface] Set the owner to the Organization

This operation sets an SDOSystemElement to the owner of the Organization. The SDOSystemElement to be set is specified by argument "sdo."

Parameters:

sdo - Reference of owner object.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The argument "sdo" is null, or the object that is specified by "sdo" in argument "sdo" does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

get_members

public SDO[] get_members()
                  throws NotAvailable,
                         InternalError

[CORBA interface] Get the member list of the Organization

This operation returns a list of SDOs that are members of an Organization. An empty list is returned if the Organization does not have any members.

Returns:

Member SDOs that are contained in the Organization object.

Throws:

SDONotExists - The target SDO does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

set_members

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

[CORBA interface] Set SDO

This operation assigns a list of SDOs to an Organization as its members. If the Organization has already maintained a member SDO(s) when it is called, the operation replaces the member(s) with specified list of SDOs.

Parameters:

sdos - Member SDOs to be assigned.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The argument "SDOList" is null, or the object that is specified by the argument "sdos" does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

add_members

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

[CORBA interface] Add the member SDOs

This operation adds a member that is an SDO to the organization. The member to be added is specified by argument "sdo."

Parameters:

sdo_list - The member to be added to the organization.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The argument "sdo" is null.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

remove_member

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

[CORBA interface] Remove member SDO from Organization

This operation removes a member from the organization. The member to be removed is specified by argument "id."

Parameters:

id - Id of the SDO to be removed from the organization.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The argument "id" is null or does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

get_dependency

public DependencyType get_dependency()
                              throws NotAvailable,
                                     InternalError

[CORBA interface] Get the DependencyType of the Organization

This operation gets the relationship "DependencyType" of the Organization.

Returns:

The relationship of the Organization as DependencyType. DependencyType is defined in Section 2.2.2, "Data Structures Used by Resource Data Model," on page 2-3 of OMG SDO Specification.

Throws:

SDONotExists - The target SDO does not exist.

NotAvailable - The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

set_dependency

public boolean set_dependency(DependencyType dependency)
                       throws NotAvailable,
                              InternalError

[CORBA interface] Set the DependencyType of the Organization

This operation sets the relationship "DependencyType" of the Organization. The value to be set is specified by argument "dependency."

Parameters:

dependency - The relationship of the Organization as DependencyType. DependencyType is defined in Section 2.2.2, "Data Structures Used by Resource Data Model," on page 2-3.

Returns:

If the operation was successfully completed.

Throws:

SDONotExists - The target SDO does not exist.

InvalidParameter - The argument "dependency" is null.

NotAvailable - i The target SDO is reachable but cannot respond.

InternalError - The target SDO cannot execute the operation completely due to some internal error.

getObjRef

public Organization getObjRef()

Gets the object.

Returns:

Organization