OpenRTM  1.0.0
Public Member Functions | List of all members
RTM::Manager Interface Reference

import"Manager.idl";

Public Member Functions

RTC::ReturnCode_t load_module (in string pathname, in string initfunc)
 Loading a module. More...
 
RTC::ReturnCode_t unload_module (in string pathname)
 Unloading a module. More...
 
ModuleProfileList get_loadable_modules ()
 Getting loadable module profiles. More...
 
ModuleProfileList get_loaded_modules ()
 Getting loaded module profiles. More...
 
ModuleProfileList get_factory_profiles ()
 Getting component factory profiles. More...
 
RTC::RTObject create_component (in string module_name)
 Creating an RT-Component. More...
 
RTC::ReturnCode_t delete_component (in string instance_name)
 Deleting an RT-Component. More...
 
RTC::RTCList get_components ()
 Getting RT-Component list running on this manager. More...
 
RTC::ComponentProfileList get_component_profiles ()
 Getting RT-Component's profile list running on this manager. More...
 
ManagerProfile get_profile ()
 Getting this manager's profile. More...
 
NVList get_configuration ()
 Getting this manager's configuration. More...
 
RTC::ReturnCode_t set_configuration (in string name, in string value)
 Setting manager's configuration. More...
 
boolean is_master ()
 Whether this manager is master or not. More...
 
ManagerList get_master_managers ()
 Getting master managers. More...
 
RTC::ReturnCode_t add_master_manager (in Manager mgr)
 Getting a master manager. More...
 
RTC::ReturnCode_t remove_master_manager (in Manager mgr)
 Removing a master manager. More...
 
ManagerList get_slave_managers ()
 Getting slave managers. More...
 
RTC::ReturnCode_t add_slave_manager (in Manager mgr)
 Getting a slave manager. More...
 
RTC::ReturnCode_t remove_slave_manager (in Manager mgr)
 Removing a slave manager. More...
 
RTC::ReturnCode_t fork ()
 
RTC::ReturnCode_t shutdown ()
 
RTC::ReturnCode_t restart ()
 
Object get_service (in string name)
 

Member Function Documentation

◆ add_master_manager()

RTC::ReturnCode_t RTM::Manager::add_master_manager ( in Manager  mgr)

Getting a master manager.

This operation add a master manager to this manager.

Parameters
mgrA master manager
Returns
ReturnCode_t

◆ add_slave_manager()

RTC::ReturnCode_t RTM::Manager::add_slave_manager ( in Manager  mgr)

Getting a slave manager.

This operation add a slave manager to this manager.

Parameters
mgrA slave manager
Returns
ReturnCode_t

◆ create_component()

RTC::RTObject RTM::Manager::create_component ( in string  module_name)

Creating an RT-Component.

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

Returns
A created RT-Component

◆ delete_component()

RTC::ReturnCode_t RTM::Manager::delete_component ( in string  instance_name)

Deleting an RT-Component.

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

Returns
Return code

◆ fork()

RTC::ReturnCode_t RTM::Manager::fork ( )

◆ get_component_profiles()

RTC::ComponentProfileList RTM::Manager::get_component_profiles ( )

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

◆ get_components()

RTC::RTCList RTM::Manager::get_components ( )

Getting RT-Component list running on this manager.

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

Returns
A list of RT-Components

◆ get_configuration()

NVList RTM::Manager::get_configuration ( )

Getting this manager's configuration.

This operation returns this manager's configuration.

Returns
Manager's configuration

◆ get_factory_profiles()

ModuleProfileList RTM::Manager::get_factory_profiles ( )

Getting component factory profiles.

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

Returns
An RT-Component factory profile list.

◆ get_loadable_modules()

ModuleProfileList RTM::Manager::get_loadable_modules ( )

Getting loadable module profiles.

This operation returns loadable module profiles.

Returns
A module profile list.

◆ get_loaded_modules()

ModuleProfileList RTM::Manager::get_loaded_modules ( )

Getting loaded module profiles.

This operation returns loaded module profiles.

Returns
A module profile list.

◆ get_master_managers()

ManagerList RTM::Manager::get_master_managers ( )

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

◆ get_profile()

ManagerProfile RTM::Manager::get_profile ( )

Getting this manager's profile.

This operation returns this manager's profile.

Returns
Manager's profile

◆ get_service()

Object RTM::Manager::get_service ( in string  name)

◆ get_slave_managers()

ManagerList RTM::Manager::get_slave_managers ( )

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

◆ is_master()

boolean RTM::Manager::is_master ( )

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.

◆ load_module()

RTC::ReturnCode_t RTM::Manager::load_module ( in string  pathname,
in string  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.

◆ remove_master_manager()

RTC::ReturnCode_t RTM::Manager::remove_master_manager ( in Manager  mgr)

Removing a master manager.

This operation removes a master manager from this manager.

Parameters
mgrA master manager
Returns
ReturnCode_t

◆ remove_slave_manager()

RTC::ReturnCode_t RTM::Manager::remove_slave_manager ( in Manager  mgr)

Removing a slave manager.

This operation removes a slave manager from this manager.

Parameters
mgrA slave manager
Returns
ReturnCode_t

◆ restart()

RTC::ReturnCode_t RTM::Manager::restart ( )

◆ set_configuration()

RTC::ReturnCode_t RTM::Manager::set_configuration ( in string  name,
in string  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

◆ shutdown()

RTC::ReturnCode_t RTM::Manager::shutdown ( )

◆ unload_module()

RTC::ReturnCode_t RTM::Manager::unload_module ( in string  pathname)

Unloading a module.

This operation unloads a specified loadable module.

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

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