Public Member Functions | Protected Member Functions | Private Attributes | List of all members
RTC::SdoServiceAdmin Class Reference

#include <SdoServiceAdmin.h>

Public Member Functions

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

Protected Member Functions

const std::string getUUID () const
 
std::string ifrToKey (std::string &ifr)
 
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...
 

Private Attributes

bool m_allConsumerEnabled
 
coil::Mutex m_consumer_mutex
 
std::vector< SdoServiceConsumerBase * > m_consumers
 SDO ServiceProfileList with mutex lock. More...
 
coil::vstring m_consumerTypes
 
coil::Mutex m_provider_mutex
 
std::vector< SdoServiceProviderBase * > m_providers
 SDO ServiceProfileList with mutex lock. More...
 
RTC::RTObject_implm_rtobj
 
::RTC::Logger rtclog
 logger More...
 

Detailed Description

Definition at line 148 of file SdoServiceAdmin.h.

Constructor & Destructor Documentation

◆ SdoServiceAdmin()

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

Constructor.

Constructor

Parameters

Definition at line 59 of file SdoServiceAdmin.cpp.

◆ ~SdoServiceAdmin()

RTC::SdoServiceAdmin::~SdoServiceAdmin ( )
virtual

Virtual destractor.

Virtual destractor.

Definition at line 155 of file SdoServiceAdmin.cpp.

Member Function Documentation

◆ addSdoServiceConsumer()

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

Add Service Consumer.

Definition at line 302 of file SdoServiceAdmin.cpp.

◆ addSdoServiceProvider()

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

Set a SDO service provider.

Definition at line 239 of file SdoServiceAdmin.cpp.

◆ getServiceProvider()

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

Definition at line 222 of file SdoServiceAdmin.cpp.

◆ getServiceProviderProfile()

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

Definition at line 200 of file SdoServiceAdmin.cpp.

◆ getServiceProviderProfiles()

SDOPackage::ServiceProfileList * RTC::SdoServiceAdmin::getServiceProviderProfiles ( )

Get ServiceProfileList of SDO Service Provider.

Definition at line 179 of file SdoServiceAdmin.cpp.

◆ getUUID()

const std::string RTC::SdoServiceAdmin::getUUID ( ) const
protected

Definition at line 471 of file SdoServiceAdmin.cpp.

◆ ifrToKey()

std::string RTC::SdoServiceAdmin::ifrToKey ( std::string &  ifr)
protected

Definition at line 480 of file SdoServiceAdmin.cpp.

◆ isEnabledConsumerType()

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

If it is enabled service type.

Definition at line 422 of file SdoServiceAdmin.cpp.

◆ isExistingConsumerType()

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

If it is existing service type.

Definition at line 449 of file SdoServiceAdmin.cpp.

◆ removeSdoServiceConsumer()

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

Remove Service Consumer.

Definition at line 379 of file SdoServiceAdmin.cpp.

◆ removeSdoServiceProvider()

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

Remove a SDO service provider.

Definition at line 268 of file SdoServiceAdmin.cpp.

Member Data Documentation

◆ m_allConsumerEnabled

bool RTC::SdoServiceAdmin::m_allConsumerEnabled
private

Definition at line 340 of file SdoServiceAdmin.h.

◆ m_consumer_mutex

coil::Mutex RTC::SdoServiceAdmin::m_consumer_mutex
private

Definition at line 360 of file SdoServiceAdmin.h.

◆ m_consumers

std::vector<SdoServiceConsumerBase*> RTC::SdoServiceAdmin::m_consumers
private

SDO ServiceProfileList with mutex lock.

Definition at line 359 of file SdoServiceAdmin.h.

◆ m_consumerTypes

coil::vstring RTC::SdoServiceAdmin::m_consumerTypes
private

Definition at line 339 of file SdoServiceAdmin.h.

◆ m_provider_mutex

coil::Mutex RTC::SdoServiceAdmin::m_provider_mutex
private

Definition at line 350 of file SdoServiceAdmin.h.

◆ m_providers

std::vector<SdoServiceProviderBase*> RTC::SdoServiceAdmin::m_providers
private

SDO ServiceProfileList with mutex lock.

Definition at line 349 of file SdoServiceAdmin.h.

◆ m_rtobj

RTC::RTObject_impl& RTC::SdoServiceAdmin::m_rtobj
private

Definition at line 338 of file SdoServiceAdmin.h.

◆ rtclog

::RTC::Logger RTC::SdoServiceAdmin::rtclog
private

logger

Definition at line 369 of file SdoServiceAdmin.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:48