OpenRTM-aist-Python 1.1.2
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__
 Constructor. More...
 
def __del__
 Virtual destructor. More...
 
def load_module
 Loading a module. More...
 
def unload_module
 Unloading a module. More...
 
def get_loadable_modules
 Getting loadable module profiles. More...
 
def get_loaded_modules
 Getting loaded module profiles. More...
 
def get_factory_profiles
 Getting component factory profiles. More...
 
def create_component
 Creating an RT-Component. More...
 
def delete_component
 Deleting an RT-Component. More...
 
def get_components
 Getting RT-Component list running on this manager. More...
 
def get_component_profiles
 Getting RT-Component's profile list running on this manager. More...
 
def get_profile
 Getting this manager's profile. More...
 
def get_configuration
 Getting this manager's configuration. More...
 
def set_configuration
 Setting manager's configuration. More...
 
def is_master
 Whether this manager is master or not. More...
 
def get_master_managers
 Getting master managers. More...
 
def add_master_manager
 Getting a master manager. More...
 
def remove_master_manager
 Removing a master manager. More...
 
def get_slave_managers
 Getting slave managers. More...
 
def add_slave_manager
 Getting a slave manager. More...
 
def remove_slave_manager
 Removing a slave manager. More...
 
def fork
 The copy of the process is generated. More...
 
def shutdown
 This method shutdowns RTC. More...
 
def restart
 This method restarts RTC. More...
 
def get_service
 Get the reference of RTC. More...
 
def getObjRef
 Get the reference of Manager. More...
 
def createINSManager
 喇根:true, 己窃:false. More...
 
def findManager
 Find the reference of Manager. More...
 

Detailed Description

 

Constructor & Destructor Documentation

def OpenRTM_aist.ManagerServant.ManagerServant.__init__ (   self)

Constructor.

Constructor

def OpenRTM_aist.ManagerServant.ManagerServant.__del__ (   self)

Virtual destructor.

Member Function Documentation

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);

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);

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)

def OpenRTM_aist.ManagerServant.ManagerServant.createINSManager (   self)

喇根:true, 己窃:false.

Generate INSManager.

Returns
Successful:true, Failed:false

bool createINSManager();

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)

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);

def OpenRTM_aist.ManagerServant.ManagerServant.fork (   self)

The copy of the process is generated.

Returns
ReturnCode_t

ReturnCode_t fork()

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

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

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

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

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

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

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

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

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

Get the reference of RTC.

Returns
RTC reference

Object_ptr get_service(const char* name)

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

def OpenRTM_aist.ManagerServant.ManagerServant.getObjRef (   self)

Get the reference of Manager.

Returns
Manager reference

Manager_ptr getObjRef() const

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

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)

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);

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);

def OpenRTM_aist.ManagerServant.ManagerServant.restart (   self)

This method restarts RTC.

Returns
ReturnCode_t

ReturnCode_t restart()

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)

def OpenRTM_aist.ManagerServant.ManagerServant.shutdown (   self)

This method shutdowns RTC.

Returns
ReturnCode_t

ReturnCode_t shutdown()

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)


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