ExampleMemory.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::ExampleMemory
 * @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 <map>
#include <mutex>
 
#include <ArmarXCore/core/Component.h>
#include <ArmarXCore/interface/observers/ObserverInterface.h>
 
#include <ArmarXGui/libraries/ArmarXGuiComponentPlugins/LightweightRemoteGuiComponentPlugin.h>
 
#include <RobotAPI/libraries/armem/core/Prediction.h>
#include <RobotAPI/libraries/armem/server/plugins/ReadWritePluginUser.h>
 
namespace armarx
{
    /**
     * @defgroup Component-ExampleMemory ExampleMemory
     * @ingroup RobotAPI-Components
     * A description of the component ExampleMemory.
     *
     * @class ExampleMemory
     * @ingroup Component-ExampleMemory
     * @brief Brief description of class ExampleMemory.
     *
     * Detailed description of class ExampleMemory.
     */
    class ExampleMemory :
        virtual public armarx::Component,
        virtual public armem::server::ReadWritePluginUser,
        virtual public LightweightRemoteGuiComponentPluginUser
    {
    public:
        /// @see armarx::ManagedIceObject::getDefaultName()
        std::string getDefaultName() const override;
 
 
        // WritingInterface interface
    public:
        armem::data::AddSegmentsResult addSegments(const armem::data::AddSegmentsInput& input,
                                                   const Ice::Current&) override;
        armem::data::CommitResult commit(const armem::data::Commit& commit,
                                         const Ice::Current& = Ice::emptyCurrent) override;
 
        // ReadingInterface interface
        armem::query::data::Result query(const armem::query::data::Input& input,
                                         const Ice::Current& = Ice::emptyCurrent) override;
 
 
        // LightweightRemoteGuiComponentPluginUser interface
    public:
        void createRemoteGuiTab();
        void RemoteGui_update() override;
 
        // ActionsInterface interface
    public:
        armem::actions::GetActionsOutputSeq
        getActions(const armem::actions::GetActionsInputSeq& input) override;
        armem::actions::ExecuteActionOutputSeq
        executeActions(const armem::actions::ExecuteActionInputSeq& input) override;
 
 
    protected:
        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
 
        void onInitComponent() override;
        void onConnectComponent() override;
        void onDisconnectComponent() override;
        void onExitComponent() override;
 
 
    private:
        armem::PredictionResult predictLatest(const armem::PredictionRequest& request);
 
        // Client statistics tracking
        struct ClientStatistics
        {
            std::string connectionString;
            std::string remoteAddress;
            int remotePort = -1;
            int clientPid = -1;  // From Ice context if available
            size_t commitCount = 0;
            size_t queryCount = 0;
            armem::Time firstSeen;
            armem::Time lastCommit;
            armem::Time lastQuery;
        };
 
        std::string extractClientIdentifier(const Ice::Current& current) const;
        std::string formatClientIdentifier(const std::string& connectionString) const;
        void parseConnectionInfo(const std::string& connectionString, std::string& address, int& port) const;
        int extractClientPid(const Ice::Current& current) const;
        void recordCommit(const Ice::Current& current);
        void recordQuery(const Ice::Current& current);
        void logClientStatistics() const;
        RemoteGui::Client::GroupBox createClientStatisticsGroupBox();
        void updateClientStatisticsLabels();
        void updateClientStatisticsLabelsInternal();  // Internal version without mutex lock
 
        mutable std::mutex clientStatsMutex;
        mutable std::map<std::string, ClientStatistics> clientStats;
 
        armarx::DebugObserverInterfacePrx debugObserver;
 
        struct Properties
        {
            struct CoreSegments
            {
                std::vector<std::string> defaultCoreSegments = {"ExampleModality",
                                                                "ExampleConcept"};
                std::string _defaultSegmentsStr;
                bool addOnUsage = false;
            };
 
            CoreSegments core;
 
            bool enableRemoteGui = false;
            bool showMemoryContent = true;  // Show memory content in RemoteGui
            bool showClientStats = true;    // Show client statistics in RemoteGui
            bool publishToDebugObserver = false;  // Publish client statistics to DebugObserver
        };
 
        Properties p;
 
        // Client index tracking for DebugObserver channel naming
        std::map<std::string, int> clientIndices;
        int nextClientIndex = 1;
        int getClientIndex(const std::string& clientId);
 
        struct RemoteGuiTab : RemoteGui::Client::Tab
        {
            std::atomic_bool rebuild = false;
 
            RemoteGui::Client::GroupBox memoryGroup;
            RemoteGui::Client::GroupBox clientStatsGroup;
 
            // Labels for updating client statistics without rebuilding
            RemoteGui::Client::Label summaryLabel;
            std::map<std::string, RemoteGui::Client::Label> clientLabels;
            std::map<std::string, RemoteGui::Client::Label> connectionLabels;
 
            armem::Time lastStatsUpdate;
            int statsUpdateIntervalMs = 10000;  // Update every 10 seconds
        };
 
        RemoteGuiTab tab;
    };
} // namespace armarx