openrtm_aist: ManagerServant.h Source File

Go to the documentation of this file.
 // -*- C++ -*-
 #ifndef RTM_MANAGERSERVANT_H
 #define RTM_MANAGERSERVANT_H
 
 #include <iostream>
 #include <coil/Mutex.h>
 #include <coil/Guard.h>
 #include <rtm/idl/ManagerSkel.h>
 #include <rtm/Manager.h>
 #include <rtm/SystemLogger.h>
 
 namespace RTM
 {
   class ManagerServant
     : public virtual POA_RTM::Manager,
       public virtual PortableServer::RefCountServantBase
   {
   public:
     // standard constructor
     ManagerServant();
 
     virtual ~ManagerServant(void);
 
     RTC::ReturnCode_t load_module(const char* pathname, const char* initfunc);
 
     RTC::ReturnCode_t unload_module(const char* pathname);
 
     RTM::ModuleProfileList* get_loadable_modules();
 
     RTM::ModuleProfileList* get_loaded_modules();
 
     // component 関連
     RTM::ModuleProfileList* get_factory_profiles();
 
     RTC::RTObject_ptr create_component(const char* module_name);
 
     RTC::ReturnCode_t delete_component(const char* instance_name);
 
     RTC::RTCList* get_components();
 
     RTC::ComponentProfileList* get_component_profiles();
 
     // manager 基本    /*!
     * @if jp
     * @brief マネージャのプロファイルを取得する
     *
     * 現在当該マネージャのプロファイルを取得する。
     *
     * @return マネージャプロファイル
     *
     * @else
     * @brief Getting this manager's profile.
     *
     * This operation returns this manager's profile.
     *
     * @return Manager's profile
     *
     * @endif
     */
    RTM::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
     *
     * @endif
     */
    RTM::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
     *
     * @endif
     */
    RTC::ReturnCode_t set_configuration(const char* name, const char* 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.
     *
     * @endif
     */
    ::CORBA::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
     *
     * @endif
     */
    RTM::ManagerList* get_master_managers();

    /*!
     * @if jp
     * @brief マスターマネージャの追加
     *
     * このマネージャのマスタとしてマネージャを一つ追加する。戻り値には、
     * 当該マネージャ上で追加されたマスターマネージャを識別するユニーク
     * なIDが返される。このマネージャがマスタの場合、当該IDで指定された
     * マスターマネージャを返す。IDで指定されたマスターマネージャがない
     * 場合、nilオブジェクトが返る。
     *
     * @return マスターマネージャ
     *
     * @else
     * @brief 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.
     *  
     * @return A master manager
     *
     * @endif
     */
    RTC::ReturnCode_t add_master_manager(RTM::Manager_ptr 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 
     *
     * @endif
     */
    RTC::ReturnCode_t remove_master_manager(RTM::Manager_ptr 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
     *
     * @endif
     */
    RTM::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
     *
     * @endif
     */
    RTC::ReturnCode_t add_slave_manager(RTM::Manager_ptr 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 
     *
     * @endif
     */
    RTC::ReturnCode_t remove_slave_manager(RTM::Manager_ptr mgr);



    /*!
     * @if jp
     * @brief プロセスのコピーを生成する
     * @return ReturnCode_t
     * @else
     * @brief The copy of the process is generated. 
     * @return ReturnCode_t 
     * @endif
     */
    RTC::ReturnCode_t fork();
    /*!
     * @if jp
     * @brief shutdownする
     * @return ReturnCode_t
     * @else
     * @brief This method shutdowns RTC. 
     * @return ReturnCode_t 
     * @endif
     */
    RTC::ReturnCode_t shutdown();
    /*!
     * @if jp
     * @brief 再起動する。
     * @return ReturnCode_t
     * @else
     * @brief This method restarts RTC.  
     * @return ReturnCode_t 
     * @endif
     */
    RTC::ReturnCode_t restart();

    /*!
     * @if jp
     * @brief RTCのリファレンスを取得する。
     * @return RTCのリファレンス
     * @else
     * @brief Get the reference of RTC. 
     * @return RTC reference
     * @endif
     */
    CORBA::Object_ptr get_service(const char* name);

    /*!
     * @if jp
     * @brief Managerのリファレンスを取得する。
     * @return Managerのリファレンス
     * @else
     * @brief Get the reference of Manager. 
     * @return Manager reference
     * @endif
     */
    RTM::Manager_ptr getObjRef() const;

    /*!
     * @if jp
     * @brief INSManagerの生成
     * @return 
     * @else 成功:true, 失敗:false
     * @brief Generate INSManager. 
     * @return Successful:true, Failed:false
     * @endif
     */
    bool createINSManager();

    /*!
     * @if jp
     * @brief Managerのリファレンスを検索する。
     * @return Managerのリファレンス
     * @else
     * @brief Find the reference of Manager. 
     * @return Manager reference
     * @endif
     */
    RTM::Manager_ptr findManager(const char* host_port);

  private:
    typedef coil::Guard<coil::Mutex> Guard;
    /*!
     * @if jp
     * @brief ロガーオブジェクト
     * @else
     * @brief Logger object
     * @endif
     */
    ::RTC::Logger rtclog;

    /*!
     * @if jp
     * @brief RTC::Managerへの参照
     * @else
     * @brief Reference to the RTC::Manager
     * @endif
     */
    ::RTC::Manager& m_mgr;

    /*!
     * @if jp
     * @brief ManagerServantのオブジェクトリファレンス
     * @else
     * @brief An object reference of ManagerServant
     * @endif
     */
    ::RTM::Manager_var m_objref;

    /*!
     * @if jp
     * @brief マスタマネージャのリスト
     * @else
     * @brief List of master managers
     * @endif
     */
    ::RTM::ManagerList m_masters;

    /*!
     * @if jp
     * @brief m_masters の Mutex
     * @else
     * @brief Mutex of m_masters
     * @endif
     */
    ::coil::Mutex m_masterMutex;

    /*!
     * @if jp
     * @brief スレーブマネージャのリスト
     * @else
     * @brief List of slave managers
     * @endif
     */
    ::RTM::ManagerList m_slaves;

    /*!
     * @if jp
     * @brief m_slaves の Mutex
     * @else
     * @brief Mutex of m_slaves
     * @endif
     */
    ::coil::Mutex m_slaveMutex;

    /*!
     * @if jp
     * @brief マスタかどうかのフラグ
     * @else
     * @brief Flag if this is master
     * @endif
     */
    CORBA::Boolean m_isMaster;

    /*!
     * @if jp
     * @brief Manager_var が等価かどうかのファンクタ
     * @else
     * @brief Functor to inspect if Manster_var is equivalent
     * @endif
     */
    class is_equiv
    {
      RTM::Manager_var m_mgr;
    public:
      is_equiv(RTM::Manager_ptr mgr)
        : m_mgr(RTM::Manager::_duplicate(mgr)) {}
      bool operator()(RTM::Manager_ptr mgr)
      {
        return m_mgr->_is_equivalent(mgr);
      }
    };

  };
}; // namespace RTM
#endif // RTM_MANAGERSERVANT_H
     RTM::ManagerProfile* get_profile();
 
     RTM::NVList* get_configuration();
 
     RTC::ReturnCode_t set_configuration(const char* name, const char* value);
 
     ::CORBA::Boolean is_master();
 
     RTM::ManagerList* get_master_managers();
 
     RTC::ReturnCode_t add_master_manager(RTM::Manager_ptr mgr);
 
     RTC::ReturnCode_t remove_master_manager(RTM::Manager_ptr mgr);
 
     RTM::ManagerList* get_slave_managers();
 
     RTC::ReturnCode_t add_slave_manager(RTM::Manager_ptr mgr);
 
     RTC::ReturnCode_t remove_slave_manager(RTM::Manager_ptr mgr);
 
 
 
     RTC::ReturnCode_t fork();
     RTC::ReturnCode_t shutdown();
     RTC::ReturnCode_t restart();
 
     CORBA::Object_ptr get_service(const char* name);
 
     RTM::Manager_ptr getObjRef() const;
 
     bool createINSManager();
 
     RTM::Manager_ptr findManager(const char* host_port);
 
   private:
     typedef coil::Guard<coil::Mutex> Guard;
     ::RTC::Logger rtclog;
 
     ::RTC::Manager& m_mgr;
 
     ::RTM::Manager_var m_objref;
 
     ::RTM::ManagerList m_masters;
 
     ::coil::Mutex m_masterMutex;
 
     ::RTM::ManagerList m_slaves;
 
     ::coil::Mutex m_slaveMutex;
 
     CORBA::Boolean m_isMaster;
 
     class is_equiv
     {
       RTM::Manager_var m_mgr;
     public:
       is_equiv(RTM::Manager_ptr mgr)
         : m_mgr(RTM::Manager::_duplicate(mgr)) {}
       bool operator()(RTM::Manager_ptr mgr)
       {
         return m_mgr->_is_equivalent(mgr);
       }
     };
 
   };
 }; // namespace RTM
 #endif // RTM_MANAGERSERVANT_H