OpenRTM-aist-Python 2.0.0
Classes | Public Member Functions | List of all members
OpenRTM_aist.ManagerServant.ManagerServant Class Reference
Inheritance diagram for OpenRTM_aist.ManagerServant.ManagerServant:

Classes

class  is_equiv
 

Public Member Functions

def __init__ (self)
 
def __del__ (self)
 
def exit (self)
 
def load_module (self, pathname, initfunc)
 
def unload_module (self, pathname)
 
def get_loadable_modules (self)
 
def get_loaded_modules (self)
 
def get_factory_profiles (self)
 
def create_component (self, module_name)
 
def delete_component (self, instance_name)
 
def get_components (self)
 
def get_component_profiles (self)
 
def get_profile (self)
 
def get_configuration (self)
 
def set_configuration (self, name, value)
 
def is_master (self)
 
def get_master_managers (self)
 
def add_master_manager (self, mgr)
 
def remove_master_manager (self, mgr)
 
def get_slave_managers (self)
 
def add_slave_manager (self, mgr)
 
def remove_slave_manager (self, mgr)
 
def fork (self)
 
def shutdown (self)
 
def restart (self)
 
def get_service (self, name)
 
def getObjRef (self)
 
def createINSManager (self)
 成功:true, 失敗:false More...
 
def findManager (self, host_port)
 
def get_components_by_name (self, name)
 
def findManagerByName (self, manager_name)
 
def getParameterByModulename (self, param_name, module_name)
 
def createComponentByManagerName (self, module_name)
 
def createComponentByAddress (self, module_name)
 
def updateMasterManager (self)
 

Detailed Description

 

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.ManagerServant.ManagerServant.__init__ (   self)

Constructor

Constructor

◆ __del__()

def OpenRTM_aist.ManagerServant.ManagerServant.__del__ (   self)

Virtual destructor

Member Function Documentation

◆ add_master_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.add_master_manager (   self,
  mgr 
)

Getting a master manager

This operation returns a master manager with specified id. If the manager with the specified id does not exist, nil object reference would be returned.

Returns
A master manager

RTC::ReturnCode_t add_master_manager(RTM::Manager_ptr mgr);

◆ add_slave_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.add_slave_manager (   self,
  mgr 
)

Getting a slave manager

This operation add a slave manager to this manager.

Parameters
mgrA slave manager
Returns
ReturnCode_t

RTC::ReturnCode_t add_slave_manager(RTM::Manager_ptr mgr);

◆ create_component()

def OpenRTM_aist.ManagerServant.ManagerServant.create_component (   self,
  module_name 
)

Creating an RT-Component

This operation creates RT-Component according to the string argument.

Returns
A created RT-Component

RTObject_ptr create_component(const char* module_name)

◆ createComponentByAddress()

def OpenRTM_aist.ManagerServant.ManagerServant.createComponentByAddress (   self,
  module_name 
)

Parameters
self
module_name
Returns
RTC::RTObject_ptr createComponentByAddress(string module_name)

◆ createComponentByManagerName()

def OpenRTM_aist.ManagerServant.ManagerServant.createComponentByManagerName (   self,
  module_name 
)

Parameters
self
module_name
Returns
RTC::RTObject_ptr createComponentByManagerName(string module_name)

◆ createINSManager()

def OpenRTM_aist.ManagerServant.ManagerServant.createINSManager (   self)

成功:true, 失敗:false

Generate INSManager.

Returns
Successful:true, Failed:false

bool createINSManager();

◆ delete_component()

def OpenRTM_aist.ManagerServant.ManagerServant.delete_component (   self,
  instance_name 
)

Deleting an RT-Component

This operation delete an RT-Component according to the string argument.

Returns
Return code

ReturnCode_t delete_component(const char* instance_name)

◆ exit()

def OpenRTM_aist.ManagerServant.ManagerServant.exit (   self)

◆ findManager()

def OpenRTM_aist.ManagerServant.ManagerServant.findManager (   self,
  host_port 
)

Find the reference of Manager.

Returns
Manager reference

RTM::Manager_ptr findManager(const char* host_port);

◆ findManagerByName()

def OpenRTM_aist.ManagerServant.ManagerServant.findManagerByName (   self,
  manager_name 
)

Parameters
self
manager_name
Returns
RTC::Manager_ptr findManagerByName(string manager_name)

◆ fork()

def OpenRTM_aist.ManagerServant.ManagerServant.fork (   self)

The copy of the process is generated.

Returns
ReturnCode_t

ReturnCode_t fork()

◆ get_component_profiles()

def OpenRTM_aist.ManagerServant.ManagerServant.get_component_profiles (   self)

Getting RT-Component's profile list running on this manager

This operation returns RT-Component's profile list running on this manager.

Returns
A list of RT-Components' profiles

ComponentProfileList* get_component_profiles()

◆ get_components()

def OpenRTM_aist.ManagerServant.ManagerServant.get_components (   self)

Getting RT-Component list running on this manager

This operation returns RT-Component list running on this manager.

Returns
A list of RT-Components

RTCList* get_components()

◆ get_components_by_name()

def OpenRTM_aist.ManagerServant.ManagerServant.get_components_by_name (   self,
  name 
)

Parameters
self
name
Returns
RTCList get_components_by_name(string name)

◆ get_configuration()

def OpenRTM_aist.ManagerServant.ManagerServant.get_configuration (   self)

Getting this manager's configuration.

This operation returns this manager's configuration.

Returns
Manager's configuration

NVList* get_configuration()

◆ get_factory_profiles()

def OpenRTM_aist.ManagerServant.ManagerServant.get_factory_profiles (   self)

Getting component factory profiles

This operation returns component factory profiles from loaded RT-Component module factory profiles.

Returns
An RT-Component factory profile list.

ModuleProfileList* get_factory_profiles()

◆ get_loadable_modules()

def OpenRTM_aist.ManagerServant.ManagerServant.get_loadable_modules (   self)

Getting loadable module profiles

This operation returns loadable module profiles.

Returns
A module profile list.

ModuleProfileList* get_loadable_modules()

◆ get_loaded_modules()

def OpenRTM_aist.ManagerServant.ManagerServant.get_loaded_modules (   self)

Getting loaded module profiles

This operation returns loaded module profiles.

Returns
A module profile list.

ModuleProfileList* get_loaded_modules()

◆ get_master_managers()

def OpenRTM_aist.ManagerServant.ManagerServant.get_master_managers (   self)

Getting master managers

This operation returns master manager list if this manager is slave. If this manager is master, an empty sequence would be returned.

Returns
Master manager list

RTM::ManagerList* get_master_managers();

◆ get_profile()

def OpenRTM_aist.ManagerServant.ManagerServant.get_profile (   self)

Getting this manager's profile.

This operation returns this manager's profile.

Returns
Manager's profile

ManagerProfile* get_profile()

◆ get_service()

def OpenRTM_aist.ManagerServant.ManagerServant.get_service (   self,
  name 
)

Get the reference of RTC.

Returns
RTC reference

Object_ptr get_service(const char* name)

◆ get_slave_managers()

def OpenRTM_aist.ManagerServant.ManagerServant.get_slave_managers (   self)

Getting slave managers

This operation returns slave manager list if this manager is slave. If this manager is slave, an empty sequence would be returned.

Returns
Slave manager list

RTM::ManagerList* get_slave_managers();

◆ getObjRef()

def OpenRTM_aist.ManagerServant.ManagerServant.getObjRef (   self)

Get the reference of Manager.

Returns
Manager reference

Manager_ptr getObjRef() const

◆ getParameterByModulename()

def OpenRTM_aist.ManagerServant.ManagerServant.getParameterByModulename (   self,
  param_name,
  module_name 
)

Parameters
self
param_name
module_name
Returns
std::string getParameterByModulename(string param_name, string &module_name)

◆ is_master()

def OpenRTM_aist.ManagerServant.ManagerServant.is_master (   self)

Whether this manager is master or not

It returns "True" if this manager is a master, and it returns "False" in other cases.

Returns
A boolean value that means it is master or not.

bool is_master();

◆ load_module()

def OpenRTM_aist.ManagerServant.ManagerServant.load_module (   self,
  pathname,
  initfunc 
)

Loading a module

This operation loads a specified loadable module、and perform initialization with the specified function.

Parameters
pathnameA path to a loading module.
initfuncModule initialization function.
Returns
The return code.

ReturnCode_t load_module(const char* pathname, const char* initfunc)

◆ remove_master_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.remove_master_manager (   self,
  mgr 
)

Removing a master manager

This operation removes a master manager from this manager.

Parameters
mgrA master manager
Returns
ReturnCode_t

RTC::ReturnCode_t remove_master_manager(RTM::Manager_ptr mgr);

◆ remove_slave_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.remove_slave_manager (   self,
  mgr 
)

Removing a slave manager

This operation removes a slave manager from this manager.

Parameters
mgrA slave manager
Returns
ReturnCode_t

RTC::ReturnCode_t remove_slave_manager(RTM::Manager_ptr mgr);

◆ restart()

def OpenRTM_aist.ManagerServant.ManagerServant.restart (   self)

This method restarts RTC.

Returns
ReturnCode_t

ReturnCode_t restart()

◆ set_configuration()

def OpenRTM_aist.ManagerServant.ManagerServant.set_configuration (   self,
  name,
  value 
)

Setting manager's configuration

This operation sets managers configuration.

Parameters
nameA configuration key name to be set
valueA configuration value to be set
Returns
Return code

ReturnCode_t set_configuration(const char* name, const char* value)

◆ shutdown()

def OpenRTM_aist.ManagerServant.ManagerServant.shutdown (   self)

This method shutdowns RTC.

Returns
ReturnCode_t

ReturnCode_t shutdown()

◆ unload_module()

def OpenRTM_aist.ManagerServant.ManagerServant.unload_module (   self,
  pathname 
)

Unloading a module

This operation unloads a specified loadable module.

Parameters
pathnameA path to a loading module.
Returns
The return code.

ReturnCode_t unload_module(const char* pathname)

◆ updateMasterManager()

def OpenRTM_aist.ManagerServant.ManagerServant.updateMasterManager (   self)

Parameters
selfvoid updateMasterManager()

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