Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

Organization_impl Class Reference

List of all members.

Public Member Functions

 get_organization_id ()
 [CORBA interface] Get Organization Id
 get_organization_property ()
 [CORBA interface] Get OrganizationProperty
 get_organization_property_value (name)
 [CORBA interface] Get specified value of OrganizationProperty
 set_organization_property (org_property)
 [CORBA interface] Set OrganizationProperty
 set_organization_property_value (name, value)
 [CORBA interface] Set specified value of OrganizationProperty
 remove_organization_property (name)
 [CORBA interface] Remove specified OrganizationProperty
 get_owner ()
 [CORBA interface] Get the owner of the SDO
 set_owner (sdo)
 [CORBA interface] Set the orner of the Organization
 get_members ()
 [CORBA interface] Get a menber list of the Organization
 set_members (sdos)
 [CORBA interface] Set SDO's ServiceProfile
 add_members (sdo_list)
 [CORBA interface] Add the menebr SDOs
 remove_member (id)
 [CORBA interface] Remove menber SDO from Organization
 get_dependency ()
 [CORBA interface] Get the DependencyType of the Organization
 set_dependency (dependency)
 [CORBA interface] Set the DependencyType of the Organization

Classes

class  nv_name
class  sdo_id

Member Function Documentation

Organization_impl::add_members sdo_list   ) 
 

[CORBA interface] Add the menebr 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 The member to be added to the organization.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The argument "sdo" is null.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::get_dependency  ) 
 

[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.
Exceptions:
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.

Organization_impl::get_members  ) 
 

[CORBA interface] Get a menber 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.
Exceptions:
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.

Organization_impl::get_organization_id  ) 
 

[CORBA interface] Get Organization Id

This operation returns the 'id' of the Organization.

Returns:
The id of the Organization defined in the resource data model.
Exceptions:
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.

Organization_impl::get_organization_property  ) 
 

[CORBA interface] Get OrganizationProperty

This operation returns the OrganizationProperty that an Organization has. An empty OrganizationProperty is returned if the Organization does not have any properties.

Returns:
The list with properties of the organization.
Exceptions:
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.

Organization_impl::get_organization_property_value name   ) 
 

[CORBA interface] Get specified value of OrganizationProperty

This operation returns a value in the OrganizationProperty. The value to be returned is specified by argument "name."

Parameters:
name The name of the value to be returned.
Returns:
The value of property which is specified by argument "name."
Exceptions:
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.

Organization_impl::get_owner  ) 
 

[CORBA interface] Get the owner of the SDO

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

Returns:
Reference of owner object.
Exceptions:
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.

Organization_impl::remove_member id   ) 
 

[CORBA interface] Remove menber 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.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The argument "id" is null or does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::remove_organization_property name   ) 
 

[CORBA interface] Remove specified 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.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The property that is specified by argument "name" does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::set_dependency dependency   ) 
 

[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.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The argument "dependency" is null.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::set_members sdos   ) 
 

[CORBA interface] Set SDO's ServiceProfile

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.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The argument "SDOList" is null, or if the object that is specified by the argument "sdos" does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::set_organization_property org_property   ) 
 

[CORBA interface] Set OrganizationProperty

※ SDO Specification の PIM 記述とオペレーション名が異なる。 ※ addOrganizationProperty に対応か? This operation adds the OrganizationProperty to an Organization. The OrganizationProperty is the property description of an Organization.

Parameters:
org_property The type of organization to be added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Organization_impl::set_organization_property_value name  ,
value 
 

[CORBA interface] Set specified value of OrganizationProperty

This operation adds or updates a pair of name and value as a property of Organization to/in NVList of the OrganizationProperty. The name and the value to be added/updated are specified by argument "name" and "value."

Parameters:
name The name of the property to be added/updated.
value The value of the property to be added/updated.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The property that is specified by argument "name" does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

Organization_impl::set_owner sdo   ) 
 

[CORBA interface] Set the orner of 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.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The argument "sdo" is null, or the object that is specified by "sdo" in argument "sdo" does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.


The documentation for this class was generated from the following file:
Generated on Mon Oct 29 15:51:44 2007 for OpenRTM by  doxygen 1.4.3