OpenRTM  1.0.0
Manager.idl
[詳解]
1 // -*- IDL -*-
18 /*
19  * $Log: not supported by cvs2svn $
20  *
21  */
22 
23 #ifndef __MANAGER_IDL__
24 #define __MANAGER_IDL__
25 
26 #include "SDOPackage.idl"
27 #include "RTC.idl"
28 
29 module RTM
30 {
32 
34  {
35  NVList properties;
36  };
37 
38  typedef sequence<ModuleProfile> ModuleProfileList;
39 
41  {
42  NVList properties;
43  };
44 
45  interface Manager;
46  typedef sequence<Manager> ManagerList;
47 
48  interface Manager
49  {
50  // module Ϣ
74  RTC::ReturnCode_t load_module(in string pathname, in string initfunc);
75 
95  RTC::ReturnCode_t unload_module(in string pathname);
96 
114  ModuleProfileList get_loadable_modules();
115 
133  ModuleProfileList get_loaded_modules();
134 
135  // component Ϣ
155  ModuleProfileList get_factory_profiles();
156 
175  RTC::RTObject create_component(in string module_name);
176 
195  RTC::ReturnCode_t delete_component(in string instance_name);
196 
214  RTC::RTCList get_components();
215 
235  RTC::ComponentProfileList get_component_profiles();
236 
237  // manager /*! * @if jp * @brief ޥ͡Υץե * * ޥ͡Υץե롣 * * @return ޥ͡ץե * * @else * @brief Getting this manager's profile. * * This operation returns this manager's profile. * * @return Manager's profile * * @endig */ ManagerProfile get_profile(); /*! * @if jp * @brief ޥ͡Υե졼 * * ޥ͡Υե졼롣 * * @return ޥ͡㥳ե졼 * * @else * @brief Getting this manager's configuration. * * This operation returns this manager's configuration. * * @return Manager's configuration * * @endig */ NVList get_configuration(); /*! * @if jp * @brief ޥ͡Υե졼ꤹ * * ޥ͡Υե졼ꤹ롣 * * @param name åȤ륳ե졼Υ̾ * @param value åȤ륳ե졼 * @return ꥿󥳡 * * @else * @brief Setting manager's configuration * * This operation sets managers configuration. * * @param name A configuration key name to be set * @param value A configuration value to be set * @return Return code * * @endig */ RTC::ReturnCode_t set_configuration(in string name, in string value); /*! * @if jp * @brief ޥ͡㤬ޥɤ * * δؿϥޥ͡㤬ޥɤ֤TrueʤС * ͡ϥޥǤꡢʳ False ֤ * * @return ޥޥ͡㤫ɤbool * * @else * @brief Whether this manager is master or not * * It returns "True" if this manager is a master, and it returns * "False" in other cases. * * @return A boolean value that means it is master or not. * * @endig */ boolean is_master(); /*! * @if jp * @brief ޥޥ͡μ * * Υޥ͡㤬졼֥ޥ͡ξ硢ޥȤʤäƤ * ͡ΥꥹȤ֤Υޥ͡㤬ޥξ硢Υꥹ * Ȥ֤롣 * * @return ޥޥ͡Υꥹ * * @else * @brief 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. * * @return Master manager list * * @endig */ ManagerList get_master_managers(); /*! * @if jp * @brief ޥޥ͡ɲ * * Υޥ͡ΥޥȤƥޥ͡ɲä롣 * * @param mgr ޥޥ͡ * @return ReturnCode_t * * @else * @brief Getting a master manager * * This operation add a master manager to this manager. * * @param mgr A master manager * @return ReturnCode_t * * @endig */ RTC::ReturnCode_t add_master_manager(in Manager mgr); /*! * @if jp * @brief ޥޥ͡κ * * Υޥ͡㤬ݻޥΤꤵ줿Τ롣 * * @param mgr ޥޥ͡ * @return ReturnCode_t * * @else * @brief Removing a master manager * * This operation removes a master manager from this manager. * * @param mgr A master manager * @return ReturnCode_t * * @endig */ RTC::ReturnCode_t remove_master_manager(in Manager mgr); /*! * @if jp * @brief 졼֥ޥ͡μ * * Υޥ͡㤬졼֥ޥ͡ξ硢졼֤ȤʤäƤ * ͡ΥꥹȤ֤Υޥ͡㤬졼֤ξ硢Υꥹ * Ȥ֤롣 * * @return 졼֥ޥ͡Υꥹ * * @else * @brief 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. * * @return Slave manager list * * @endig */ ManagerList get_slave_managers(); /*! * @if jp * @brief 졼֥ޥ͡ɲ * * Υޥ͡ΥޥȤƥޥ͡ɲä롣 * * @param mgr 졼֥ޥ͡ * @return ReturnCode_t * * @else * @brief Getting a slave manager * * This operation add a slave manager to this manager. * * @param mgr A slave manager * @return ReturnCode_t * * @endig */ RTC::ReturnCode_t add_slave_manager(in Manager mgr); /*! * @if jp * @brief 졼֥ޥ͡κ * * Υޥ͡㤬ݻޥΤꤵ줿Τ롣 * * @param mgr 졼֥ޥ͡ * @return ReturnCode_t * * @else * @brief Removing a slave manager * * This operation removes a slave manager from this manager. * * @param mgr A slave manager * @return ReturnCode_t * * @endig */ RTC::ReturnCode_t remove_slave_manager(in Manager mgr); RTC::ReturnCode_t fork(); RTC::ReturnCode_t shutdown(); RTC::ReturnCode_t restart(); Object get_service(in string name); // ServiceProfileList get_service_profiles(); }; }; // end of namespace RTM #endif // __MANAGER_IDL__
255  ManagerProfile get_profile();
256 
274  NVList get_configuration();
275 
297  RTC::ReturnCode_t set_configuration(in string name, in string value);
298 
318  boolean is_master();
319 
341  ManagerList get_master_managers();
342 
362  RTC::ReturnCode_t add_master_manager(in Manager mgr);
363 
383  RTC::ReturnCode_t remove_master_manager(in Manager mgr);
384 
406  ManagerList get_slave_managers();
426  RTC::ReturnCode_t add_slave_manager(in Manager mgr);
427 
447  RTC::ReturnCode_t remove_slave_manager(in Manager mgr);
448 
449  RTC::ReturnCode_t fork();
450  RTC::ReturnCode_t shutdown();
451  RTC::ReturnCode_t restart();
452 
453  Object get_service(in string name);
454  // ServiceProfileList get_service_profiles();
455  };
456 
457 }; // end of namespace RTM
458 
459 #endif // __MANAGER_IDL__
sequence< NameValue > NVList
Definition: SDOPackage.idl:68
Definition: Manager.idl:48
sequence< ComponentProfile > ComponentProfileList
Definition: RTC.idl:2384
Definition: Manager.idl:33
NVList properties
Definition: Manager.idl:42
Definition: Manager.idl:40
Definition: RTC.idl:2621
sequence< RTObject > RTCList
Definition: RTC.idl:1739
NVList properties
Definition: Manager.idl:35
SDOPackage::NVList NVList
Definition: Manager.idl:31
sequence< Manager > ManagerList
Definition: Manager.idl:45
sequence< ModuleProfile > ModuleProfileList
Definition: Manager.idl:38
ReturnCode_t
ReturnCode_t.
Definition: RTC.idl:82
Definition: Manager.idl:29