OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RTM::LocalServiceAdmin Class Reference

#include <LocalServiceAdmin.h>

Inheritance diagram for RTM::LocalServiceAdmin:
Inheritance graph
[legend]
Collaboration diagram for RTM::LocalServiceAdmin:
Collaboration graph
[legend]

Public Member Functions

 LocalServiceAdmin ()
 Constructor.
 
virtual ~LocalServiceAdmin ()
 Virtual destractor.
 
void init (coil::Properties &props)
 Initialization of LocalServiceAdmin.
 
void finalize ()
 Finalization ofLocalServiceAdmin.
 
::RTM::LocalServiceProfileList getServiceProfiles ()
 Getting LocalServiceProfileList.
 
bool getServiceProfile (const std::string &name, ::RTM::LocalServiceProfile &prof)
 Get LocalServiceProfile of an LocalService.
 
::RTM::LocalServiceBasegetService (const char *id)
 Get a pointer of a LocalService.
 
bool addLocalService (::RTM::LocalServiceBase *service)
 Set a SDO service provider.
 
bool removeLocalService (const std::string &name)
 Remove a LocalService.
 

Constructor & Destructor Documentation

◆ LocalServiceAdmin()

RTM::LocalServiceAdmin::LocalServiceAdmin ( )

Constructor.

Constructor

◆ ~LocalServiceAdmin()

virtual RTM::LocalServiceAdmin::~LocalServiceAdmin ( )
virtual

Virtual destractor.

Virtual destractor.

Member Function Documentation

◆ addLocalService()

bool RTM::LocalServiceAdmin::addLocalService ( ::RTM::LocalServiceBase service)

Set a SDO service provider.

◆ finalize()

void RTM::LocalServiceAdmin::finalize ( )

Finalization ofLocalServiceAdmin.

TODO: Documentation

◆ getService()

::RTM::LocalServiceBase * RTM::LocalServiceAdmin::getService ( const char *  id)

Get a pointer of a LocalService.

This operation returnes a pointer to the LocalService which has the specified id. If the specified id is NULL pointer or the specified id does not exist in the ServiceProfile list, NULL pointer will be returned.

Parameters
idID of a LocalService
Returns
a pointer which has the specified id

◆ getServiceProfile()

bool RTM::LocalServiceAdmin::getServiceProfile ( const std::string &  name,
::RTM::LocalServiceProfile prof 
)

Get LocalServiceProfile of an LocalService.

This operation returns LocalServiceProfile of a LocalService which has the specified id. If the specified id is NULL pointer or the specified id does not exist in the ServiceProfile list, false will be returned.

Parameters
idID of an LocalService
Returns
LocalServiceProfile which has the specified id

◆ getServiceProfiles()

::RTM::LocalServiceProfileList RTM::LocalServiceAdmin::getServiceProfiles ( )

Getting LocalServiceProfileList.

TODO: Documentation

◆ init()

void RTM::LocalServiceAdmin::init ( coil::Properties &  props)

Initialization of LocalServiceAdmin.

TODO: Documentation

◆ removeLocalService()

bool RTM::LocalServiceAdmin::removeLocalService ( const std::string &  name)

Remove a LocalService.


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