IceProxyWidgetController.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 ArmarXGui::gui-plugins::IceProxyWidgetController
17 * @author Raphael Grimm ( raphael dot grimm at kit dot edu )
18 * @date 2016
19 * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20 * GNU General Public License
21 */
22
23#pragma once
24
26
27#include <ArmarXGui/gui-plugins/IceProxy/ui_IceProxyWidget.h>
31
32namespace armarx
33{
34 /**
35 \page ArmarXGui-GuiPlugins-IceProxy IceProxy
36 \brief The IceProxy widget allows you to gather basig information about a proxy (i.e. Its identity / ping / type ids / stringified version.).
37 The proxy can be passed as string or loaded via a proxy finder (requires the proxy to be registered to the ice grid).
38 This widget's main purpose is debugging.
39
40 \image html IceProxy.png
41
42 API Documentation \ref IceProxyWidgetController
43
44 \see IceProxyGuiPlugin
45 */
46
47 /**
48 * \class IceProxyWidgetController
49 * \brief IceProxyWidgetController brief one line description
50 *
51 * Detailed description
52 */
54 public ArmarXComponentWidgetControllerTemplate<IceProxyWidgetController>
55 {
56 Q_OBJECT
57
58 public:
59 /**
60 * Controller Constructor
61 */
62 explicit IceProxyWidgetController();
63
64 /**
65 * Controller destructor
66 */
67 ~IceProxyWidgetController() override = default;
68
69 /**
70 * @see ArmarXWidgetController::loadSettings()
71 */
72 void
73 loadSettings(QSettings* settings) override
74 {
75 }
76
77 /**
78 * @see ArmarXWidgetController::saveSettings()
79 */
80 void
81 saveSettings(QSettings* settings) override
82 {
83 }
84
85 /**
86 * Returns the Widget name displayed in the ArmarXGui to create an
87 * instance of this class.
88 */
89 static QString
91 {
92 return "Meta.IceProxy";
93 }
94
95 /**
96 * \see armarx::Component::onInitComponent()
97 */
98 void onInitComponent() override;
99
100 /**
101 * \see armarx::Component::onConnectComponent()
102 */
103 void
105 {
106 }
107
108 void loadProxy(Ice::ObjectPrx prx);
109
110 private slots:
111 void on_pushButtonFinder_clicked();
112 void on_pushButtonString_clicked();
113
114 private:
115 /**
116 * Widget Form
117 */
118 Ui::IceProxyWidget widget;
120 };
121} // namespace armarx
#define ARMARXCOMPONENT_IMPORT_EXPORT
Widget to conveniently retrieve a proxy instance name of a specific interface type (the template para...
IceProxyWidgetController()
Controller Constructor.
void loadSettings(QSettings *settings) override
void saveSettings(QSettings *settings) override
~IceProxyWidgetController() override=default
Controller destructor.
static QString GetWidgetName()
Returns the Widget name displayed in the ArmarXGui to create an instance of this class.
This file offers overloads of toIce() and fromIce() functions for STL container types.