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

SDOPackage::SDO_impl Class Reference

SDO implementation class. More...

#include <SdoSystemElement.h>

Inheritance diagram for SDOPackage::SDO_impl:

SDOPackage::SDOSystemElement_impl List of all members.

Public Member Functions

 SDO_impl (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
virtual ~SDO_impl ()
virtual char * get_sdo_id () throw (NotAvailable, InternalError)
 [CORBA interface] Getting SDO ID
virtual char * get_sdo_type () throw (NotAvailable, InternalError)
 [CORBA interface] Getting SDO type
virtual DeviceProfile * get_device_profile () throw (NotAvailable, InternalError)
 [CORBA interface] Getting SDO DeviceProfile
virtual ServiceProfileList * get_service_profiles () throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Getting SDO ServiceProfile
virtual ServiceProfile * get_service_profile (const char *id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Getting Organizations
virtual SDOService_ptr get_sdo_service (const char *id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Getting specified SDO Service's reference
virtual Configuration_ptr get_configuration () throw (InterfaceNotImplemented, NotAvailable, InternalError)
 [CORBA interface] Getting Configuration object
virtual Monitoring_ptr get_monitoring () throw (InterfaceNotImplemented, NotAvailable, InternalError)
 [CORBA interface] Get Monitoring object
virtual OrganizationList * get_organizations () throw (NotAvailable, InternalError)
 [CORBA interface] Getting Organizations
virtual NVList * get_status_list () throw (NotAvailable, InternalError)
 [CORBA interface] Get SDO Status
virtual CORBA::Any * get_status (const char *name) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Get SDO Status
void setSdoId (const char *sdo_id)
void setSdoType (const char *sdo_type)
void setDeviceProfile (const DeviceProfile &device_profile)
void setServiceProfiles (const ServiceProfileList &service_profile)
void addServiceProfile (const ServiceProfile &service_profile)
virtual OrganizationList * get_owned_organizations () throw (NotAvailable)
 [CORBA interface] Getting Organizations

Protected Attributes

SdoId m_SdoId
SdoType m_SdoType
Configuration_implm_pConfig
Configuration_var m_varConfiguration
Monitoring_var m_varMonitoring
SeqEx< NVList, NameValue > m_Status
PortableServer::ObjectId_var m_varConfigId
SDOPackage::Configuration_var m_varConfigObj
PortableServer::ObjectId_var m_varOrgId
SDOPackage::Configuration_var m_varOrgObj
SeqEx< OrganizationList, Organization_ptr > m_ownedOrganizations
CORBA::ORB_var m_pORB
PortableServer::POA_var m_pPOA

Classes

struct  nv_name
struct  SdoId
struct  SdoType
class  SeqEx

Detailed Description

SDO implementation class.

The SDO interface is used to manage elements of the SDO. All the other interfaces specified in this specification are navigated from SDO interface.


Constructor & Destructor Documentation

SDOPackage::SDO_impl::SDO_impl CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  poa
 

virtual SDOPackage::SDO_impl::~SDO_impl  )  [inline, virtual]
 


Member Function Documentation

void SDOPackage::SDO_impl::addServiceProfile const ServiceProfile &  service_profile  ) 
 

virtual Configuration_ptr SDOPackage::SDO_impl::get_configuration  )  throw (InterfaceNotImplemented, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting Configuration object

This operation returns an object implementing the Configuration interface. The Configuration interface is one of the interfaces that each SDO maintains. The interface is used to configure the attributes defined in DeviceProfile, ServiceProfile, and Organization. See OMG SDO specification Section 2.3.5, "Configuration Interface," on page 2-24 for more details about the Configuration interface.

Returns:
The Configuration interface of an SDO.
Exceptions:
InterfaceNotImplemented The target SDO has no Configuration interface.
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.

virtual DeviceProfile* SDOPackage::SDO_impl::get_device_profile  )  throw (NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting SDO DeviceProfile

This operation returns the DeviceProfile of the SDO. If the SDO does not represent any hardware device, then a DeviceProfile with empty values are returned. This operation throws SDOException with one of the following types.

Exceptions:
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
The DeviceProfile of the SDO.

virtual Monitoring_ptr SDOPackage::SDO_impl::get_monitoring  )  throw (InterfaceNotImplemented, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Get Monitoring object

This operation returns an object implementing the Monitoring interface. The Monitoring interface is one of the interfaces that each SDO maintains. The interface is used to monitor the properties of an SDO. See OMG SDO specification Section 2.3.7, "Monitoring Interface," on page 2-35 for more details about the Monitoring interface.

Returns:
The Monitoring interface of an SDO.
Exceptions:
InterfaceNotImplemented The target SDO has no Configuration interface.
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.

virtual OrganizationList* SDOPackage::SDO_impl::get_organizations  )  throw (NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting Organizations

An SDO belongs to zero or more organizations. If the SDO belongs to one or more organizations, this operation returns the list of organizations that the SDO belongs to. An empty list is returned if the SDO does not belong to any Organizations.

Returns:
The list of Organizations that the SDO belong to.
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.

virtual OrganizationList* SDOPackage::SDOSystemElement_impl::get_owned_organizations  )  throw (NotAvailable) [virtual, inherited]
 

[CORBA interface] Getting Organizations

SDOSystemElement can be the owner of zero or more organizations. If the SDOSystemElement owns one or more Organizations, this operation returns the list of Organizations that the SDOSystemElement owns. If it does not own any Organization, it returns empty list.

virtual char* SDOPackage::SDO_impl::get_sdo_id  )  throw (NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting SDO ID

This operation returns id of the SDO. This operation throws SDOException with one of the following types.

Exceptions:
SDONotExists if the target SDO does not exist.
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
id of the SDO defined in the resource data model.

virtual SDOService_ptr SDOPackage::SDO_impl::get_sdo_service const char *  id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting specified SDO Service's reference

This operation returns an object implementing an SDO's service that is identified by the identifier specified as an argument. Different services provided by an SDO are distinguished with different identifiers. See OMG SDO specification Section 2.2.8, "ServiceProfile," on page 2-12 for more details.

Parameters:
id The identifier referring to one of the SDO Service
Returns:
The object implementing the requested service.

virtual char* SDOPackage::SDO_impl::get_sdo_type  )  throw (NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting SDO type

This operation returns sdoType of the SDO. This operation throws SDOException with one of the following types.

Exceptions:
SDONotExists if the target SDO does not exist.
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
Type of the SDO defined in the resource data model.

virtual ServiceProfile* SDOPackage::SDO_impl::get_service_profile const char *  id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting Organizations

This operation returns the ServiceProfile that is specified by the argument "id."

Parameters:
id The identifier referring to one of the ServiceProfiles.
Returns:
The profile of the specified service.
Exceptions:
NotAvailable If the target SDO is reachable but cannot respond.
InternalError If the target SDO cannot execute the operation completely due to some internal error.

virtual ServiceProfileList* SDOPackage::SDO_impl::get_service_profiles  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Getting SDO ServiceProfile

This operation returns a list of ServiceProfiles that the SDO has. If the SDO does not provide any service, then an empty list is returned. This operation throws SDOException with one of the following types.

Exceptions:
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
List of ServiceProfiles of all the services the SDO is providing.

virtual CORBA::Any* SDOPackage::SDO_impl::get_status const char *  name  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

[CORBA interface] Get SDO Status

Parameters:
name One of the parameters defining the "status" of an SDO.
Returns:
The value of the specified status parameter.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The parameter defined by "name" is null or does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

virtual NVList* SDOPackage::SDO_impl::get_status_list  )  throw (NotAvailable, InternalError) [virtual]
 

[CORBA interface] Get SDO Status

This operation returns an NVlist describing the status of an SDO.

Returns:
The actual status of an SDO.
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.

void SDOPackage::SDO_impl::setDeviceProfile const DeviceProfile &  device_profile  ) 
 

void SDOPackage::SDO_impl::setSdoId const char *  sdo_id  ) 
 

void SDOPackage::SDO_impl::setSdoType const char *  sdo_type  ) 
 

void SDOPackage::SDO_impl::setServiceProfiles const ServiceProfileList &  service_profile  ) 
 


Member Data Documentation

SeqEx<OrganizationList, Organization_ptr> SDOPackage::SDOSystemElement_impl::m_ownedOrganizations [protected, inherited]
 

Configuration_impl* SDOPackage::SDO_impl::m_pConfig [protected]
 

CORBA::ORB_var SDOPackage::SDOSystemElement_impl::m_pORB [protected, inherited]
 

PortableServer::POA_var SDOPackage::SDOSystemElement_impl::m_pPOA [protected, inherited]
 

SdoId SDOPackage::SDO_impl::m_SdoId [protected]
 

SdoType SDOPackage::SDO_impl::m_SdoType [protected]
 

SeqEx<NVList, NameValue> SDOPackage::SDO_impl::m_Status [protected]
 

PortableServer::ObjectId_var SDOPackage::SDO_impl::m_varConfigId [protected]
 

SDOPackage::Configuration_var SDOPackage::SDO_impl::m_varConfigObj [protected]
 

Configuration_var SDOPackage::SDO_impl::m_varConfiguration [protected]
 

Monitoring_var SDOPackage::SDO_impl::m_varMonitoring [protected]
 

PortableServer::ObjectId_var SDOPackage::SDO_impl::m_varOrgId [protected]
 

SDOPackage::Configuration_var SDOPackage::SDO_impl::m_varOrgObj [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Oct 28 02:28:18 2006 for OpenRTM by  doxygen 1.4.1