OpenRTM-aist-Python 2.0.2
OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin Class Reference

Public Member Functions

 __init__ (self)
 
 init (self, props)
 
 finalize (self)
 
 getServiceProfiles (self)
 
 getServiceProfile (self, name)
 
 getService (self, id)
 
 addLocalService (self, service)
 
 removeLocalService (self, name)
 
 isEnabled (self, id, enabled)
 
 notExisting (self, id)
 

Detailed Description

 

Constructor & Destructor Documentation

◆ __init__()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.__init__ ( self)

Constructor

Constructor

Member Function Documentation

◆ addLocalService()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.addLocalService ( self,
service )

Set a SDO service provider

TODO: Documentation

bool addLocalService(.RTM.LocalServiceBase* service);

◆ finalize()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.finalize ( self)

Finalization ofLocalServiceAdmin

TODO: Documentation

void finalize();

◆ getService()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.getService ( self,
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

RTM.LocalServiceBase* getService(const char* id);

◆ getServiceProfile()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.getServiceProfile ( self,
name )

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

bool getServiceProfile(std.string name, .RTM.LocalServiceProfile& prof);

◆ getServiceProfiles()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.getServiceProfiles ( self)

Getting LocalServiceProfileList

TODO: Documentation

RTM.LocalServiceProfileList getServiceProfiles();

◆ init()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.init ( self,
props )

Initialization of LocalServiceAdmin

TODO: Documentation

void init(coil.Properties& props);

◆ isEnabled()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.isEnabled ( self,
id,
enabled )

Check if specified ID is enabled bool isEnabled(const std.string& id, const coil.vstring& enabled);

◆ notExisting()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.notExisting ( self,
id )

Check if specified ID is existing bool notExisting(const std.string& id);

◆ removeLocalService()

OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.removeLocalService ( self,
name )

Remove a LocalService

TODO: Documentation

bool removeLocalService(const std.string name);


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