ArmarXManagerItem.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarX::Gui
19  * @author Jan Issac ( jan.issac at gmail dot com)
20  * @date 2012
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 
25 
26 #pragma once
27 
28 #include <mutex>
29 
30 #include <QObject>
31 #include <QStandardItem>
32 
36 
37 #include "ManagedIceObjectItem.h"
38 
39 namespace armarx
40 {
41  class ArmarXManagerItem : public QStandardItem
42  {
43  public:
44  using ObjectMap = QMap<QString, ManagedIceObjectItem>;
45 
46  struct ManagerData
47  {
48  QString name;
49  bool online = false;
50  ArmarXManagerInterfacePrx proxy;
52  ObjectPropertyInfos appProperties;
53  Ice::ConnectionPtr connection;
54  QString endpointStr;
55  };
56 
57  using ManagerDataMap = std::map<QString, ManagerData>;
58 
59  public:
60  explicit ArmarXManagerItem(const QString& name);
61 
62  ~ArmarXManagerItem() override
63  {
64  }
65 
66  QString getName() const;
67  bool isOnline() const;
68  ArmarXManagerInterfacePrx getManagerProxy() const;
69  Ice::ConnectionPtr getConnection() const;
70  QString getEndpointStr() const;
72 
73  void setName(QString name);
74  void setOnline(bool online);
75  void setManagerProxy(ArmarXManagerInterfacePrx proxy);
76  void setAppProperties(const ObjectPropertyInfos& properties);
77  void setConnection(Ice::ConnectionPtr connection);
78  void setEndpointStr(const QString& endpointStr);
79  const ObjectPropertyInfos& getAppProperties() const;
80  /**
81  * Clears the item data.
82  */
83  void clear(bool clearProxy = true);
84 
85  /**
86  * Returns the access mutex
87  *
88  * @return Access mutex
89  */
90  std::mutex& getMutex();
91 
92  private:
93  ManagerData data;
94  std::mutex mutex;
95  };
96 } // namespace armarx
armarx::ArmarXManagerItem::ManagerData::appProperties
ObjectPropertyInfos appProperties
Definition: ArmarXManagerItem.h:52
ArmarXManager.h
armarx::ArmarXManagerItem::getName
QString getName() const
Definition: ArmarXManagerItem.cpp:56
armarx::ArmarXManagerItem::getConnection
Ice::ConnectionPtr getConnection() const
Definition: ArmarXManagerItem.cpp:74
armarx::ArmarXManagerItem::isOnline
bool isOnline() const
Definition: ArmarXManagerItem.cpp:62
armarx::ArmarXManagerItem::setConnection
void setConnection(Ice::ConnectionPtr connection)
Definition: ArmarXManagerItem.cpp:127
armarx::ArmarXManagerItem::setOnline
void setOnline(bool online)
Definition: ArmarXManagerItem.cpp:105
ManagedIceObjectItem.h
armarx::ArmarXManagerItem::ManagerData::proxy
ArmarXManagerInterfacePrx proxy
Definition: ArmarXManagerItem.h:50
armarx::ArmarXManagerItem::ManagerData::online
bool online
Definition: ArmarXManagerItem.h:49
armarx::ArmarXManagerItem::setAppProperties
void setAppProperties(const ObjectPropertyInfos &properties)
Definition: ArmarXManagerItem.cpp:121
armarx::ArmarXManagerItem::getAppProperties
const ObjectPropertyInfos & getAppProperties() const
Definition: ArmarXManagerItem.cpp:139
armarx::ArmarXManagerItem::setManagerProxy
void setManagerProxy(ArmarXManagerInterfacePrx proxy)
Definition: ArmarXManagerItem.cpp:113
armarx::ArmarXManagerItem::ManagerData::name
QString name
Definition: ArmarXManagerItem.h:48
armarx::ArmarXManagerItem::~ArmarXManagerItem
~ArmarXManagerItem() override
Definition: ArmarXManagerItem.h:62
ManagedIceObject.h
armarx::ArmarXManagerItem::ManagerDataMap
std::map< QString, ManagerData > ManagerDataMap
Definition: ArmarXManagerItem.h:57
armarx::ArmarXManagerItem::getMutex
std::mutex & getMutex()
Returns the access mutex.
Definition: ArmarXManagerItem.cpp:145
armarx::ArmarXManagerItem::ArmarXManagerItem
ArmarXManagerItem(const QString &name)
Definition: ArmarXManagerItem.cpp:30
armarx::ArmarXManagerItem::ManagerData::objects
ObjectMap objects
Definition: ArmarXManagerItem.h:51
armarx::ArmarXManagerItem::ManagerData::connection
Ice::ConnectionPtr connection
Definition: ArmarXManagerItem.h:53
armarx::ArmarXManagerItem::setEndpointStr
void setEndpointStr(const QString &endpointStr)
Definition: ArmarXManagerItem.cpp:133
armarx::ArmarXManagerItem::clear
void clear(bool clearProxy=true)
Clears the item data.
Definition: ArmarXManagerItem.cpp:36
armarx::ArmarXManagerItem::ObjectMap
QMap< QString, ManagedIceObjectItem > ObjectMap
Definition: ArmarXManagerItem.h:44
armarx::ArmarXManagerItem::getObjects
ObjectMap & getObjects()
Definition: ArmarXManagerItem.cpp:86
ManagedIceObjectRegistryInterface.h
armarx::ArmarXManagerItem::ManagerData
Definition: ArmarXManagerItem.h:46
armarx::ArmarXManagerItem
Definition: ArmarXManagerItem.h:41
armarx::ArmarXManagerItem::setName
void setName(QString name)
Definition: ArmarXManagerItem.cpp:92
armarx::ArmarXManagerItem::ManagerData::endpointStr
QString endpointStr
Definition: ArmarXManagerItem.h:54
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::ArmarXManagerItem::getManagerProxy
ArmarXManagerInterfacePrx getManagerProxy() const
Definition: ArmarXManagerItem.cpp:68
armarx::ArmarXManagerItem::getEndpointStr
QString getEndpointStr() const
Definition: ArmarXManagerItem.cpp:80