Organization implementation class.
More...
#include <SdoOrganization.h>
|
| Organization_impl (SDOSystemElement_ptr sdo) |
| Constructor.
|
|
| ~Organization_impl () override |
| Virtual destructor.
|
|
char * | get_organization_id () override |
| [CORBA interface] Get Organization ID
|
|
CORBA::Boolean | add_organization_property (const OrganizationProperty &organization_property) override |
| [CORBA interface] Set OrganizationProperty
|
|
OrganizationProperty * | get_organization_property () override |
| [CORBA interface] Get OrganizationProperty
|
|
CORBA::Any * | get_organization_property_value (const char *name) override |
| [CORBA interface] Get specified value of OrganizationProperty
|
|
CORBA::Boolean | set_organization_property_value (const char *name, const CORBA::Any &value) override |
| [CORBA interface] Set specified value of OrganizationProperty
|
|
CORBA::Boolean | remove_organization_property (const char *name) override |
| [CORBA interface] Remove specified OrganizationProperty
|
|
CORBA::Boolean | add_members (const SDOList &sdo_list) override |
| [CORBA interface] Add the member SDOs
|
|
SDOList * | get_members () override |
| [CORBA interface] Get the member list of the Organization
|
|
CORBA::Boolean | set_members (const SDOList &sdos) override |
| [CORBA interface] Set SDO
|
|
CORBA::Boolean | remove_member (const char *id) override |
| [CORBA interface] Remove member SDO from Organization
|
|
SDOSystemElement_ptr | get_owner () override |
| [CORBA interface] Get the owner of Organization
|
|
CORBA::Boolean | set_owner (SDOSystemElement_ptr sdo) override |
| [CORBA interface] Set the owner to the Organization
|
|
DependencyType | get_dependency () override |
| [CORBA interface] Get the DependencyType of the Organization
|
|
CORBA::Boolean | set_dependency (DependencyType dependency) override |
| [CORBA interface] Set the DependencyType of the Organization
|
|
Organization_ptr | getObjRef () |
|
Organization implementation class.
Organization interface is an interface to add and delete etc data defined by Resource Data Model.
- Since
- 0.4.0
◆ Organization_impl()
SDOPackage::Organization_impl::Organization_impl |
( |
SDOSystemElement_ptr | sdo | ) |
|
|
explicit |
◆ ~Organization_impl()
SDOPackage::Organization_impl::~Organization_impl |
( |
| ) |
|
|
override |
Virtual destructor.
Virtual Virtual destructor
◆ add_members()
CORBA::Boolean SDOPackage::Organization_impl::add_members |
( |
const SDOList & | sdo_list | ) |
|
|
override |
[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.
- Exceptions
-
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. |
◆ add_organization_property()
CORBA::Boolean SDOPackage::Organization_impl::add_organization_property |
( |
const OrganizationProperty & | organization_property | ) |
|
|
override |
[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
-
org_property | The type of organization to be added. |
- Returns
- If the operation was successfully completed.
- Exceptions
-
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. |
◆ get_dependency()
DependencyType SDOPackage::Organization_impl::get_dependency |
( |
| ) |
|
|
override |
[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.(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. |
◆ get_members()
SDOList * SDOPackage::Organization_impl::get_members |
( |
| ) |
|
|
override |
[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.
- Exceptions
-
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. |
InternalError | The target SDO cannot execute the operation completely due to some internal error. |
◆ get_organization_id()
char * SDOPackage::Organization_impl::get_organization_id |
( |
| ) |
|
|
override |
[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.(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. |
◆ get_organization_property()
OrganizationProperty * SDOPackage::Organization_impl::get_organization_property |
( |
| ) |
|
|
override |
[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.(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. |
◆ get_organization_property_value()
CORBA::Any * SDOPackage::Organization_impl::get_organization_property_value |
( |
const char * | name | ) |
|
|
override |
[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.(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. |
◆ get_owner()
SDOSystemElement_ptr SDOPackage::Organization_impl::get_owner |
( |
| ) |
|
|
override |
[CORBA interface] Get the owner of Organization
This operation returns the SDOSystemElement that is owner of the Organization.
- Returns
- Reference of owner object.
- Exceptions
-
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. |
InternalError | The target SDO cannot execute the operation completely due to some internal error. |
◆ getObjRef()
Organization_ptr SDOPackage::Organization_impl::getObjRef |
( |
| ) |
|
◆ remove_member()
CORBA::Boolean SDOPackage::Organization_impl::remove_member |
( |
const char * | id | ) |
|
|
override |
[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.
- Exceptions
-
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. |
◆ remove_organization_property()
CORBA::Boolean SDOPackage::Organization_impl::remove_organization_property |
( |
const char * | name | ) |
|
|
override |
[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.(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. |
◆ set_dependency()
CORBA::Boolean SDOPackage::Organization_impl::set_dependency |
( |
DependencyType | dependency | ) |
|
|
override |
[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.(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. |
◆ set_members()
CORBA::Boolean SDOPackage::Organization_impl::set_members |
( |
const SDOList & | sdos | ) |
|
|
override |
[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.
- Exceptions
-
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. |
◆ set_organization_property_value()
CORBA::Boolean SDOPackage::Organization_impl::set_organization_property_value |
( |
const char * | name, |
|
|
const CORBA::Any & | value ) |
|
override |
[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.(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. |
◆ set_owner()
CORBA::Boolean SDOPackage::Organization_impl::set_owner |
( |
SDOSystemElement_ptr | sdo | ) |
|
|
override |
[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.
- Exceptions
-
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. |
◆ m_dependency
SDOPackage::DependencyType SDOPackage::Organization_impl::m_dependency |
|
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.
- 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_memberList
SDOPackage::SDOList SDOPackage::Organization_impl::m_memberList |
|
protected |
A list of SDO members associated with the Organization .
◆ m_objref
Organization_var SDOPackage::Organization_impl::m_objref |
|
protected |
◆ m_org_mutex
std::mutex SDOPackage::Organization_impl::m_org_mutex |
|
protected |
◆ m_orgProperty
SDOPackage::OrganizationProperty SDOPackage::Organization_impl::m_orgProperty |
|
protected |
Organization property.
OrganizationProperty contains the properties of an Organization. An Organization has zero or one (at most one) instance of OrganizationProperty.
◆ m_pId
std::string SDOPackage::Organization_impl::m_pId |
|
protected |
The identifier of the Organization. .
◆ m_varOwner
SDOPackage::SDOSystemElement_var SDOPackage::Organization_impl::m_varOwner |
|
protected |
The owner of the Organization .
◆ rtclog
The documentation for this class was generated from the following file: