Classes | Public Member Functions | Private Attributes | List of all members
OpenRTM_aist.SdoOrganization.Organization_impl Class Reference

Organization implementation class. More...

Inheritance diagram for OpenRTM_aist.SdoOrganization.Organization_impl:
Inheritance graph
[legend]

Classes

class  nv_name
 
class  sdo_id
 

Public Member Functions

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

Private Attributes

 __rtcout
 
 _dependency
 
 _memberList
 
 _objref
 
 _org_mutex
 
 _orgProperty
 
 _pId
 
 _varOwner
 

Detailed Description

Organization implementation class.

The Organization interface is used to manage the Organization attribute.

Since
0.4.0

Definition at line 47 of file SdoOrganization.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 61 of file SdoOrganization.py.

Member Function Documentation

◆ add_members()

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
sdoThe member to be added to the organization.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "sdo" is null.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 631 of file SdoOrganization.py.

◆ add_organization_property()

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_propertyThe type of organization to be added.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterThe argument "organizationProperty" is null.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 258 of file SdoOrganization.py.

◆ get_dependency()

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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 743 of file SdoOrganization.py.

◆ get_members()

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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 525 of file SdoOrganization.py.

◆ get_organization_id()

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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 110 of file SdoOrganization.py.

◆ get_organization_property()

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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 150 of file SdoOrganization.py.

◆ get_organization_property_value()

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
nameThe name of the value to be returned.
Returns
The value of property which is specified by argument "name".
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterIf there are no Property stored with argument "name".
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 197 of file SdoOrganization.py.

◆ get_owner()

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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 429 of file SdoOrganization.py.

◆ getObjRef()

def OpenRTM_aist.SdoOrganization.Organization_impl.getObjRef (   self)

Definition at line 806 of file SdoOrganization.py.

◆ remove_member()

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
idId of the SDO to be removed from the organization.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "id" is null or does not exist.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 683 of file SdoOrganization.py.

◆ remove_organization_property()

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
nameThe name of the property to be removed.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe property that is specified by argument "name" does not exist.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 376 of file SdoOrganization.py.

◆ set_dependency()

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
dependencyThe 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
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "dependency" is null.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 791 of file SdoOrganization.py.

◆ set_members()

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
sdosMember SDOs to be assigned.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "SDOList" is null, or if the object that is specified by the argument "sdos" does not exist.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 578 of file SdoOrganization.py.

◆ set_organization_property_value()

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
nameThe name of the property to be added/updated.
valueThe value of the property to be added/updated.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe property that is specified by argument "name" does not exist.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 319 of file SdoOrganization.py.

◆ set_owner()

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
sdoReference of owner object.
Returns
If the operation was successfully completed.
Exceptions
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "sdo" is null, or the object that is specified by "sdo" in argument "sdo" does not exist.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 475 of file SdoOrganization.py.

Member Data Documentation

◆ __rtcout

OpenRTM_aist.SdoOrganization.Organization_impl.__rtcout
private

Definition at line 70 of file SdoOrganization.py.

◆ _dependency

OpenRTM_aist.SdoOrganization.Organization_impl._dependency
private

Definition at line 68 of file SdoOrganization.py.

◆ _memberList

OpenRTM_aist.SdoOrganization.Organization_impl._memberList
private

Definition at line 67 of file SdoOrganization.py.

◆ _objref

OpenRTM_aist.SdoOrganization.Organization_impl._objref
private

Definition at line 69 of file SdoOrganization.py.

◆ _org_mutex

OpenRTM_aist.SdoOrganization.Organization_impl._org_mutex
private

Definition at line 63 of file SdoOrganization.py.

◆ _orgProperty

OpenRTM_aist.SdoOrganization.Organization_impl._orgProperty
private

Definition at line 65 of file SdoOrganization.py.

◆ _pId

OpenRTM_aist.SdoOrganization.Organization_impl._pId
private

Definition at line 62 of file SdoOrganization.py.

◆ _varOwner

OpenRTM_aist.SdoOrganization.Organization_impl._varOwner
private

Definition at line 66 of file SdoOrganization.py.


The documentation for this class was generated from the following file:


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:09