OpenRTM_aist.SdoOrganization.Organization_impl Class Reference

Organization implementation class. More...

Inheritance diagram for OpenRTM_aist.SdoOrganization.Organization_impl:
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECOrganization

List of all members.

Classes

class  nv_name
class  sdo_id

Public Member Functions

def get_organization_id
 [CORBA interface] Get Organization Id
def get_organization_property
 [CORBA interface] Get OrganizationProperty
def get_organization_property_value
 [CORBA interface] Get specified value of OrganizationProperty
def add_organization_property
 [CORBA interface] Set OrganizationProperty
def set_organization_property_value
 [CORBA interface] Set specified value of OrganizationProperty
def remove_organization_property
 [CORBA interface] Remove specified OrganizationProperty
def get_owner
 [CORBA interface] Get the owner of the SDO
def set_owner
 [CORBA interface] Set the orner of the Organization
def get_members
 [CORBA interface] Get a menber list of the Organization
def set_members
 [CORBA interface] Set SDO's ServiceProfile
def add_members
 [CORBA interface] Add the menebr SDOs
def remove_member
 [CORBA interface] Remove menber SDO from Organization
def get_dependency
 [CORBA interface] Get the DependencyType of the Organization
def set_dependency
 [CORBA interface] Set the DependencyType of the Organization

Detailed Description

Organization implementation class. 

The Organization interface is used to manage the Organization attribute.


Since:
0.4.0 


Member Function Documentation






      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.add_members 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
sdo The member to be added to the organization.

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  





Reimplemented in OpenRTM_aist.PeriodicECSharedComposite.PeriodicECOrganization.











      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.add_organization_property 
          (
           
           self, 
        

        

          
          
           
           org_property 
        

        

          
          )
          
        

      







[CORBA interface] Set OrganizationProperty 


This operation adds the OrganizationProperty to an Organization. The OrganizationProperty is the property description of an Organization.


Parameters:

  

    
self 

    
org_property The type of organization to be added.

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if 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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_dependency 
          (
           
           self
           ) 
          
        

      







[CORBA interface] Get the DependencyType of the Organization 


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


Parameters:

  

    
self 

  

  




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 if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_members 
          (
           
           self
           ) 
          
        

      







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


Parameters:

  

    
self 

  

  




Returns:
Member SDOs that are contained in the Organization object.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_id 
          (
           
           self
           ) 
          
        

      







[CORBA interface] Get Organization Id 


This operation returns the 'id' of the Organization.


Parameters:

  

    
self 

  

  




Returns:
The id of the Organization defined in the resource data model.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_property 
          (
           
           self
           ) 
          
        

      







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


Parameters:

  

    
self 

  

  




Returns:
The list with properties of the organization.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_organization_property_value 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
name The name of the value to be returned.

  

  




Returns:
The value of property which is specified by argument "name".


Exceptions:

  

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

    
InvalidParameter If there are no Property stored with argument "name". 

    
NotAvailable The target SDO is reachable but cannot respond. 

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

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.get_owner 
          (
           
           self
           ) 
          
        

      







[CORBA interface] Get the owner of the SDO 


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


Parameters:

  

    
self 

  

  




Returns:
Reference of owner object.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.remove_member 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

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

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  





Reimplemented in OpenRTM_aist.PeriodicECSharedComposite.PeriodicECOrganization.











      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.remove_organization_property 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
name The name of the property to be removed.

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.set_dependency 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
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 if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.set_members 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
sdos Member SDOs to be assigned.

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  





Reimplemented in OpenRTM_aist.PeriodicECSharedComposite.PeriodicECOrganization.











      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.set_organization_property_value 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
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 if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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. 

  

  













      

        

          def OpenRTM_aist.SdoOrganization.Organization_impl.set_owner 
          (
           
           self, 
        

        

          
          
           
           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:

  

    
self 

    
sdo Reference of owner object.

  

  




Returns:
If the operation was successfully completed.


Exceptions:

  

    
SDONotExists if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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 Mar 2 14:14:05 2015 for OpenRTM-aist-1.1.0-Python by 

doxygen 1.6.3