PeriodicUpdateController.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * Copyright (C) 2012-2025, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
 *
 * 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    RobotStateComponent::
 * @author     Samet Soenmez (uewtt at student dot kit dot edu)
 * @date       2025t
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <QObject>
 
#include <RobotAPI/libraries/armem_gui/util/MemoryTypes.h>
#include <RobotAPI/libraries/armem_gui/model/MemoryViewerModel.h>
#include <RobotAPI/libraries/armem_gui/view/periodic_update/PeriodicUpdateView.h>
#include <RobotAPI/libraries/armem_gui/controller/MemoryGroupBoxController.h>
#include <RobotAPI/libraries/armem_gui/controller/PeriodicUpdateWorker.h>
 
class QTimer;
class QLayout;
class QBoxLayout;
class QGroupBox;
class QLabel;
class QThread;
 
namespace armarx::armem::gui::controller
{
    /**
     * @brief controlls periodic tasks and associated view components
     * 
     * manages two periodic tasks which are executed in a new worker thread.
     * Communication between the threads is handled with signals.
     */
    class PeriodicUpdateController : public QObject, public armarx::Logging
    {
        Q_OBJECT
        using This = PeriodicUpdateController;
 
    public:
        PeriodicUpdateController(
            MemoryViewerUIContext& uiContext,
            std::shared_ptr<armem::gui::model::MemoryViewerModel> model);
 
        ~PeriodicUpdateController();
 
        void startAutoUpdateTimerIfEnabled();
 
        MemoryGroupBoxController* memoryGroupBoxController() const;
 
    public slots:
        void onCollapseAll();
        void onSplitBox();
        void onTimerFrequencyChanged();
        void onToggleAutoUpdates(bool enabled);
        void updateListOfActiveMemories(QStringList activeMemoryNames);
        void updateStatusLabelAndMemoryTree(int errorCount);
 
    private slots:
 
    signals:
        void startPeriodicTimerSignal();
        void stopPeriodicTimerSignal();
        void startAutoUpdateTimerSignal();
        void stopAutoUpdateTimerSignal();
        void autoUpdateTimerIntervalSignal(int freq);
 
        void update();
 
    private:
        void startWorker();
        void updateStatusLabel(int errorCount);
 
    private:
        armem::gui::view::PeriodicUpdateView* _periodicUpdateView;
        std::shared_ptr<armem::gui::model::MemoryViewerModel> _model;
        QLabel* _statusLabel;
 
        std::unique_ptr<MemoryGroupBoxController> _memoryGroupBoxController;
 
        QThread* _periodicUpdateWorkerThread = nullptr;
        PeriodicUpdateWorker* _periodicUpdateWorker;
    };
}