OpenRTM-aist  1.2.1
Public Member Functions | Protected Member Functions | List of all members
RTC::SdoServiceAdmin Class Reference

#include <SdoServiceAdmin.h>

Public Member Functions

 SdoServiceAdmin (::RTC::RTObject_impl &rtobj)
 Constructor. More...
 
virtual ~SdoServiceAdmin ()
 Virtual destractor. More...
 
virtual void init (coil::Properties &prop)
 Initialization. More...
 
SDOPackage::ServiceProfileList * getServiceProviderProfiles ()
 Get ServiceProfileList of SDO Service Provider. More...
 
SDOPackage::ServiceProfile * getServiceProviderProfile (const char *id)
 Get ServiceProfile of an SDO Service Provider. More...
 
SDOPackage::SDOService_ptr getServiceProvider (const char *id)
 Get ServiceProfile of an SDO Service. More...
 
bool addSdoServiceProvider (const SDOPackage::ServiceProfile &prof, SdoServiceProviderBase *provider)
 Set a SDO service provider. More...
 
bool removeSdoServiceProvider (const char *id)
 Remove a SDO service provider. More...
 
bool addSdoServiceConsumer (const SDOPackage::ServiceProfile &sProfile)
 Add Service Consumer. More...
 
bool removeSdoServiceConsumer (const char *id)
 Remove Service Consumer. More...
 

Protected Member Functions

void initProvider (coil::Properties &prop)
 Provider Initialization. More...
 
void initConsumer (coil::Properties &prop)
 Consumer Initialization. More...
 
bool isEnabledConsumerType (const SDOPackage::ServiceProfile &sProfile)
 If it is enabled service type. More...
 
bool isExistingConsumerType (const SDOPackage::ServiceProfile &sProfile)
 If it is existing service type. More...
 
const std::string getUUID () const
 
std::string ifrToKey (std::string &ifr)
 

Constructor & Destructor Documentation

RTC::SdoServiceAdmin::SdoServiceAdmin ( ::RTC::RTObject_impl rtobj)

Constructor.

Constructor

Parameters
virtual RTC::SdoServiceAdmin::~SdoServiceAdmin ( )
virtual

Virtual destractor.

Virtual destractor.

Member Function Documentation

bool RTC::SdoServiceAdmin::addSdoServiceConsumer ( const SDOPackage::ServiceProfile &  sProfile)

Add Service Consumer.

bool RTC::SdoServiceAdmin::addSdoServiceProvider ( const SDOPackage::ServiceProfile &  prof,
SdoServiceProviderBase provider 
)

Set a SDO service provider.

SDOPackage::SDOService_ptr RTC::SdoServiceAdmin::getServiceProvider ( const char *  id)

Get ServiceProfile of an SDO Service.

This operation returnes an object reference of an SDO Service Provider which has the specified id. If the specified id is NULL pointer or the specified id does not exist in the ServiceProfile list, InvalidParameter exception will be thrown.

Parameters
idIFR ID of an SDO Service provider
Returns
an SDO Service reference which has the specified id
SDOPackage::ServiceProfile* RTC::SdoServiceAdmin::getServiceProviderProfile ( const char *  id)

Get ServiceProfile of an SDO Service Provider.

This operation returnes ServiceProfile of an SDO Service Provider which has the specified id. If the specified id is NULL pointer or the specified id does not exist in the ServiceProfile list, InvalidParameter exception will be thrown.

Parameters
idIFR ID of an SDO Service provider
Returns
ServiceProfile which has the specified id
SDOPackage::ServiceProfileList* RTC::SdoServiceAdmin::getServiceProviderProfiles ( )

Get ServiceProfileList of SDO Service Provider.

const std::string RTC::SdoServiceAdmin::getUUID ( ) const
protected
std::string RTC::SdoServiceAdmin::ifrToKey ( std::string &  ifr)
protected
virtual void RTC::SdoServiceAdmin::init ( coil::Properties prop)
virtual

Initialization.

void RTC::SdoServiceAdmin::initConsumer ( coil::Properties prop)
protected

Consumer Initialization.

void RTC::SdoServiceAdmin::initProvider ( coil::Properties prop)
protected

Provider Initialization.

bool RTC::SdoServiceAdmin::isEnabledConsumerType ( const SDOPackage::ServiceProfile &  sProfile)
protected

If it is enabled service type.

bool RTC::SdoServiceAdmin::isExistingConsumerType ( const SDOPackage::ServiceProfile &  sProfile)
protected

If it is existing service type.

bool RTC::SdoServiceAdmin::removeSdoServiceConsumer ( const char *  id)
bool RTC::SdoServiceAdmin::removeSdoServiceProvider ( const char *  id)

Remove a SDO service provider.


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