ComponentPlugin.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  * @author Fabian Reister ( fabian dot reister at kit dot edu )
17  * @date 2024
18  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
19  * GNU General Public License
20  */
21 
22 #pragma once
23 
25 
27 
28 // forward declaring privately used classes
29 namespace armarx::armem::client
30 {
31  class MemoryNameSystem;
32 
33  namespace plugins
34  {
35  class Plugin;
36  }
37 } // namespace armarx::armem::client
38 
40 {
42  {
43  public:
44  ComponentPlugin(ManagedIceObject& parent, const std::string& pre);
45 
46  ~ComponentPlugin() override;
47 
49 
50  protected:
51  void preOnConnectComponent() override;
52 
53  private:
54  armarx::armem::client::MemoryNameSystem& memoryNameSystem();
55 
56  armarx::armem::client::plugins::Plugin* armemPlugin_ = nullptr;
57 
58  std::optional<client::ViewSelection> viewSelection_;
59  };
60 
61 } // namespace armarx::view_selection::client::plugins
62 
63 // make class available in armarx::view_selection namespace
64 namespace armarx::view_selection
65 {
67 }
armarx::view_selection::client::plugins
This file is part of ArmarX.
Definition: ComponentPlugin.cpp:30
armarx::ManagedIceObjectPlugin::parent
ManagedIceObject & parent()
Definition: ManagedIceObjectPlugin.cpp:72
armarx::armem::client
This file is part of ArmarX.
Definition: Configurator.cpp:5
armarx::view_selection::client::ViewSelection
Definition: ViewSelection.h:37
plugins
armarx::view_selection::client::plugins::ComponentPlugin
Definition: ComponentPlugin.h:41
armarx::view_selection::client::plugins::ComponentPlugin::preOnConnectComponent
void preOnConnectComponent() override
Definition: ComponentPlugin.cpp:57
armarx::view_selection::client::plugins::ComponentPlugin::ComponentPlugin
ComponentPlugin(ManagedIceObject &parent, const std::string &pre)
Definition: ComponentPlugin.cpp:32
armarx::ComponentPlugin
Definition: ComponentPlugin.h:37
armarx::view_selection::ComponentPlugin
client::plugins::ComponentPlugin ComponentPlugin
Definition: ComponentPlugin.h:66
ViewSelection.h
armarx::view_selection::client::plugins::ComponentPlugin::viewSelection
client::ViewSelection & viewSelection()
Definition: ComponentPlugin.cpp:50
armarx::ManagedIceObject
The ManagedIceObject is the base class for all ArmarX objects.
Definition: ManagedIceObject.h:162
armarx::armem::client::MemoryNameSystem
The memory name system (MNS) client.
Definition: MemoryNameSystem.h:73
ComponentPlugin.h
armarx::view_selection
Definition: ComponentPlugin.cpp:30
armarx::view_selection::client::plugins::ComponentPlugin::~ComponentPlugin
~ComponentPlugin() override
armarx::armem::client::plugins::Plugin
A component plugin offering client-side access to to the working memory system by providing a Memory ...
Definition: Plugin.h:19