ArMemMemoryViewerWidgetController.h
Go to the documentation of this file.
1/*
2 * This file is part of ArmarX.
3 *
4 * ArmarX is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * ArmarX is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 *
16 * @package RobotAPI::gui-plugins::ArMemMemoryViewerWidgetController
17 * @author Rainer Kartmann ( rainer dot kartmann at kit dot edu )
18 * @date 2020
19 * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20 * GNU General Public License
21 */
22#pragma once
23
24#include <memory>
25
27
31
32#include <RobotAPI/gui-plugins/ArMemMemoryViewer/ui_ArMemMemoryViewerWidget.h>
35
36namespace armarx
37{
38 /**
39 * @page RobotAPI-GuiPlugins-ArMemMemoryViewer ArMemMemoryViewer
40 * @brief The ArMemMemoryViewer allows visualizing ...
41 * @image html ArMemMemoryViewer.png
42 * The user can
43 *
44 * API Documentation @ref ArMemMemoryViewerWidgetController
45 *
46 * @see ArMemMemoryViewerGuiPlugin
47 */
48
49 /**
50 * @class ArMemMemoryViewerGuiPlugin
51 * @ingroup ArmarXGuiPlugins
52 * @brief ArMemMemoryViewerGuiPlugin brief description
53 *
54 * Detailed description
55 */
56
57 /**
58 * @class ArMemMemoryViewerWidgetController
59 * @brief ArMemMemoryViewerWidgetController brief one line description
60 *
61 * Detailed description
62 */
64 public armarx::ArmarXComponentWidgetControllerTemplate<ArMemMemoryViewerWidgetController>
65 {
66 Q_OBJECT
68 using MemoryViewer = armarx::armem::gui::MemoryViewer;
69
70 public:
71 static QString GetWidgetName();
72 static QIcon GetWidgetIcon();
73
75 virtual ~ArMemMemoryViewerWidgetController() override;
76
77
78 void loadSettings(QSettings* settings) override;
79 void saveSettings(QSettings* settings) override;
80
81 QPointer<QDialog> getConfigDialog(QWidget* parent) override;
82 void configured() override;
83
84
85 void onInitComponent() override;
86 void onConnectComponent() override;
87 void onDisconnectComponent() override;
88
89
90 public slots:
91
92 signals:
93
94
95 private slots:
96
97 signals:
98
99
100 private:
101 /// Widget Form
102 Ui::ArMemMemoryViewerWidget widget;
103 armarx::gui::LifecycleServer lifecycleServer;
104
105 QPointer<SimpleConfigDialog> configDialog;
106
107 std::unique_ptr<MemoryViewer> viewer;
108 };
109} // namespace armarx
#define ARMARXCOMPONENT_IMPORT_EXPORT
void onInitComponent() override
Pure virtual hook for the subclass.
void loadSettings(QSettings *settings) override
Implement to load the settings that are part of the GUI configuration.
void saveSettings(QSettings *settings) override
Implement to save the settings as part of the GUI configuration.
void onConnectComponent() override
Pure virtual hook for the subclass.
void configured() override
This function must be implemented by the user, if he supplies a config dialog.
QPointer< QDialog > getConfigDialog(QWidget *parent) override
getConfigDialog returns a pointer to the a configuration widget of this controller.
GUI component for viewing and managing memories.
This file offers overloads of toIce() and fromIce() functions for STL container types.