OpenRTM-aist-Python 2.0.0
Public Member Functions | List of all members
OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin Class Reference

Public Member Functions

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

Detailed Description

 

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.__init__ (   self)

Constructor

Constructor

Member Function Documentation

◆ addLocalService()

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

Set a SDO service provider

TODO: Documentation

bool addLocalService(::RTM::LocalServiceBase* service);

◆ finalize()

def OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.finalize (   self)

Finalization ofLocalServiceAdmin

TODO: Documentation

void finalize();

◆ getService()

def 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()

def 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()

def OpenRTM_aist.LocalServiceAdmin.LocalServiceAdmin.getServiceProfiles (   self)

Getting LocalServiceProfileList

TODO: Documentation

::RTM::LocalServiceProfileList getServiceProfiles();

◆ init()

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

Initialization of LocalServiceAdmin

TODO: Documentation

void init(coil::Properties& props);

◆ isEnabled()

def 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()

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

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

◆ removeLocalService()

def 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: