RobotNameService.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    RobotAPI::ArmarXObjects::RobotNameService
 * @author     [Author Name] ( [Author Email] )
 * @date       2018
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <map>
#include <mutex>
#include <string>
 
#include <ArmarXCore/core/Component.h>
 
#include <RobotAPI/interface/robot_name_service/RobotNameServiceInterface.h>
#include <RobotAPI/libraries/robot_name_service/core/Robot.h>
 
namespace armarx
{
    /**
     * @defgroup Component-RobotNameService RobotNameService
     * @ingroup RobotAPI-Components
     * A description of the component RobotNameService.
     *
     * @class RobotNameService
     * @ingroup Component-RobotNameService
     * @brief Brief description of class RobotNameService.
     *
     * Detailed description of class RobotNameService.
     */
    class RobotNameService :
        virtual public armarx::Component,
        virtual public armarx::robot_name_service::dti::RobotNameServiceInterface
    {
    public:
        /**
         * @see armarx::ManagedIceObject::getDefaultName()
         */
        std::string
        getDefaultName() const override
        {
            return "RobotNameService";
        }
 
    protected:
        /**
         * @see armarx::ManagedIceObject::onInitComponent()
         */
        void onInitComponent() override;
 
        /**
         * @see armarx::ManagedIceObject::onConnectComponent()
         */
        void onConnectComponent() override;
 
        /**
         * @see armarx::ManagedIceObject::onDisconnectComponent()
         */
        void onDisconnectComponent() override;
 
        /**
         * @see armarx::ManagedIceObject::onExitComponent()
         */
        void onExitComponent() override;
 
        /**
         * @see PropertyUser::createPropertyDefinitions()
         */
        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
 
 
        // RobotNameServiceInterface interface
    public:
        bool registerRobotInfo(const robot_name_service::dto::RobotInfo& robot,
                               const Ice::Current& current) override;
        void unregisterRobotInfo(const std::string& name, const Ice::Current& current) override;
        IceUtil::Optional<robot_name_service::dto::RobotInfo>
        getRobotInfo(const std::string& name, const Ice::Current& current) override;
 
    private:
        mutable std::mutex robotsMutex;
        std::map<std::string, robot_name_service::core::RobotInfo> robots;
    };
} // namespace armarx