OpenRTM-aist
1.2.1
|
Organization implementation class. More...
#include <SdoOrganization.h>
Classes | |
struct | nv_name |
Functor for NameValue. More... | |
struct | sdo_id |
Functor for SDO. More... | |
Public Member Functions | |
Organization_impl (SDOSystemElement_ptr sdo) | |
Constructor. More... | |
virtual | ~Organization_impl (void) |
Virtual destructor. More... | |
virtual char * | get_organization_id () throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Get Organization ID More... | |
virtual CORBA::Boolean | add_organization_property (const OrganizationProperty &org_property) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Set OrganizationProperty More... | |
virtual OrganizationProperty * | get_organization_property () throw (CORBA::SystemException, NotAvailable, InternalError) |
[CORBA interface] Get OrganizationProperty More... | |
virtual CORBA::Any * | get_organization_property_value (const char *name) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Get specified value of OrganizationProperty More... | |
virtual CORBA::Boolean | set_organization_property_value (const char *name, const CORBA::Any &value) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Set specified value of OrganizationProperty More... | |
virtual CORBA::Boolean | remove_organization_property (const char *name) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Remove specified OrganizationProperty More... | |
virtual CORBA::Boolean | add_members (const SDOList &sdo_list) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Add the member SDOs More... | |
virtual SDOList * | get_members () throw (CORBA::SystemException, NotAvailable, InternalError) |
[CORBA interface] Get the member list of the Organization More... | |
virtual CORBA::Boolean | set_members (const SDOList &sdos) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Set SDO More... | |
virtual CORBA::Boolean | remove_member (const char *id) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Remove member SDO from Organization More... | |
virtual SDOSystemElement_ptr | get_owner () throw (CORBA::SystemException, NotAvailable, InternalError) |
[CORBA interface] Get the owner of Organization More... | |
virtual CORBA::Boolean | set_owner (SDOSystemElement_ptr sdo) throw (CORBA::SystemException, InvalidParameter, NotAvailable, InternalError) |
[CORBA interface] Set the owner to the Organization More... | |
virtual DependencyType | get_dependency () throw (CORBA::SystemException, NotAvailable, InternalError) |
[CORBA interface] Get the DependencyType of the Organization More... | |
virtual CORBA::Boolean | set_dependency (DependencyType dependency) throw (CORBA::SystemException, NotAvailable, InternalError) |
[CORBA interface] Set the DependencyType of the Organization More... | |
Organization_ptr | getObjRef () |
Protected Attributes | |
::RTC::Logger | rtclog |
Organization_var | m_objref |
std::string | m_pId |
The identifier of the Organization. More... | |
SDOPackage::SDOList | m_memberList |
A list of SDO members associated with the Organization. More... | |
SDOPackage::SDOSystemElement_var | m_varOwner |
The owner of the Organization. More... | |
SDOPackage::DependencyType | m_dependency |
Dependency type. More... | |
SDOPackage::OrganizationProperty | m_orgProperty |
Organization property. More... | |
Mutex | m_org_mutex |
Organization implementation class.
Organization interface is an interface to add and delete etc data defined by Resource Data Model.
SDOPackage::Organization_impl::Organization_impl | ( | SDOSystemElement_ptr | sdo | ) |
Constructor.
Constructor
|
virtual |
Virtual destructor.
Virtual Virtual destructor
|
virtual |
[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."
sdo_list | The member to be added to the organization. |
SDONotExists | 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 SDOPackage::PeriodicECOrganization.
|
virtual |
[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.
org_property | The type of organization to be added. |
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. |
|
virtual |
[CORBA interface] Get the DependencyType of the Organization
This operation gets the relationship "DependencyType" of the Organization.
|
virtual |
[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.
|
virtual |
[CORBA interface] Get Organization ID
This operation returns the 'ID' of the Organization.
|
virtual |
[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.
|
virtual |
[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."
name | The name of the value to be returned. |
SDONotExists | The target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.) |
InvalidParameter | 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. |
|
virtual |
[CORBA interface] Get the owner of Organization
This operation returns the SDOSystemElement that is owner of the Organization.
|
inline |
|
virtual |
[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."
id | Id of the SDO to be removed from the organization. |
SDONotExists | 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 SDOPackage::PeriodicECOrganization.
|
virtual |
[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."
name | The name of the property to be removed. |
SDONotExists | 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. |
|
virtual |
[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."
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. |
SDONotExists | 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. |
|
virtual |
[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.
sdos | Member SDOs to be assigned. |
SDONotExists | 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 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 SDOPackage::PeriodicECOrganization.
|
virtual |
[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."
name | The name of the property to be added/updated. |
value | The value of the property to be added/updated. |
SDONotExists | 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. |
|
virtual |
[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."
sdo | Reference of owner object. |
SDONotExists | 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. |
|
protected |
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.
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.
|
protected |
A list of SDO members associated with the Organization.
|
protected |
|
protected |
|
protected |
Organization property.
OrganizationProperty contains the properties of an Organization. An Organization has zero or one (at most one) instance of OrganizationProperty.
|
protected |
The identifier of the Organization.
|
protected |
The owner of the Organization.
|
protected |