RobotStateMemory.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::RobotSensorMemory
 * @author     Rainer Kartmann ( rainer dot kartmann at kit dot edu )
 * @date       2020
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <mutex>
#include <queue>
 
#include <ArmarXCore/core/Component.h>
 
#include <ArmarXGui/libraries/ArmarXGuiComponentPlugins/LightweightRemoteGuiComponentPlugin.h>
#include <ArmarXGui/libraries/RemoteGui/Client/Tab.h>
#include <ArmarXGui/libraries/RemoteGui/Client/Widgets.h>
 
#include <RobotAPI/interface/core/RobotLocalization.h>
#include <RobotAPI/libraries/RobotAPIComponentPlugins/ArVizComponentPlugin.h>
#include <RobotAPI/libraries/RobotUnitDataStreamingReceiver/RobotUnitDataStreamingReceiver.h>
#include <RobotAPI/libraries/armem/server/plugins/ReadWritePluginUser.h>
#include <RobotAPI/libraries/armem_robot_state/server/common/Visu.h>
#include <RobotAPI/libraries/armem_robot_state/server/description/Segment.h>
#include <RobotAPI/libraries/armem_robot_state/server/exteroception/Segment.h>
#include <RobotAPI/libraries/armem_robot_state/server/localization/Segment.h>
#include <RobotAPI/libraries/armem_robot_state/server/proprioception/RobotStateWriter.h>
#include <RobotAPI/libraries/armem_robot_state/server/proprioception/RobotUnitData.h>
#include <RobotAPI/libraries/armem_robot_state/server/proprioception/RobotUnitReader.h>
#include <RobotAPI/libraries/armem_robot_state/server/proprioception/Segment.h>
 
namespace armarx::plugins
{
    class DebugObserverComponentPlugin;
    class RobotUnitComponentPlugin;
} // namespace armarx::plugins
 
namespace armarx::armem::server::robot_state
{
 
    /**
     * @defgroup Component-RobotSensorMemory RobotSensorMemory
     * @ingroup RobotAPI-Components
     * A description of the component RobotSensorMemory.
     *
     * @class RobotSensorMemory
     * @ingroup Component-RobotSensorMemory
     * @brief Brief description of class RobotSensorMemory.
     *
     * Detailed description of class RobotSensorMemory.
     */
    class RobotStateMemory :
        virtual public armarx::Component,
        virtual public armem::server::ReadWritePluginUser,
        virtual public armarx::ArVizComponentPluginUser,
        virtual public armarx::LightweightRemoteGuiComponentPluginUser,
        virtual public armarx::GlobalRobotPoseProvider
    {
    public:
        RobotStateMemory();
        ~RobotStateMemory() override;
 
 
        std::string getDefaultName() const override;
 
 
        // GlobalRobotPoseProvider interface
        armarx::PoseBasePtr getGlobalRobotPose(Ice::Long timestamp,
                                               const std::string& robotName,
                                               const ::Ice::Current& /*unused*/) override;
 
 
    protected:
        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
 
        void onInitComponent() override;
        void onConnectComponent() override;
        void onDisconnectComponent() override;
        void onExitComponent() override;
 
 
    private:
        void startRobotUnitStream();
        void stopRobotUnitStream();
 
        // RemoteGUI
        void RemoteGui_update() override;
        void createRemoteGuiTab();
        void clearRobotStateWriterQueue();
 
        struct RemoteGuiTab : armarx::RemoteGui::Client::Tab
        {
            armarx::RemoteGui::Client::Button clearRobotStateWriterQueueButton;
        };
        RemoteGuiTab tab;
 
 
        armarx::plugins::DebugObserverComponentPlugin* debugObserver = nullptr;
 
 
        // Core segments
        // - description
        description::Segment descriptionSegment;
 
        // - proprioception
        proprioception::Segment proprioceptionSegment;
        armem::data::MemoryID robotUnitProviderID;
 
        // - exteroception
        exteroception::Segment exteroceptionSegment;
 
        // - localization
        localization::Segment localizationSegment;
 
        // Joint visu for all segments => robot pose and configuration
        Visu commonVisu;
 
        struct RobotUnit
        {
            // params
            static constexpr float ROBOT_UNIT_MAXIMUM_FREQUENCY = 100;
            static constexpr const char* sensorValuePrefix = "RobotUnit.";
 
            float pollFrequency = 50;
 
            armarx::plugins::RobotUnitComponentPlugin* plugin = nullptr;
            proprioception::RobotUnitReader reader;
            proprioception::RobotStateWriter writer;
 
            // queue
            using Queue = armarx::armem::server::robot_state::proprioception::Queue;
            std::unique_ptr<Queue> dataBuffer;
 
            bool waitForRobotUnit = false;
        };
 
        RobotUnit robotUnit;
    };
 
} // namespace armarx::armem::server::robot_state