PluginUser.h
Go to the documentation of this file.
1
#pragma once
2
3
#include <
RobotAPI/libraries/armem/client/forward_declarations.h
>
4
5
#include <
ArmarXCore/core/ManagedIceObject.h
>
6
7
8
// Use this one include in your .cpp:
9
// #include <RobotAPI/libraries/armem/client/MemoryNameSystem.h>
10
11
12
namespace
armarx::armem::client::plugins
13
{
14
class
Plugin;
15
16
17
/**
18
* @brief Adds the Memory Name System client component plugin.
19
*
20
* This plugin class does not implement the `MemoryListenerInterface`.
21
* Therefore, it will not receive and process memory udpate events via the
22
* memory updates topic. If you want to receive these updates, use the
23
* `ListeningMemoryNameSystemPluginUser`.
24
*
25
*
26
* @see MemoryNameSystemPlugin
27
* @see ListeningMemoryNameSystemPluginUser
28
*/
29
class
PluginUser
:
30
virtual
public
armarx::ManagedIceObject
31
{
32
protected
:
33
34
PluginUser
();
35
virtual
~PluginUser
()
override
;
36
37
38
public
:
39
40
MemoryNameSystem
&
memoryNameSystem
();
41
const
MemoryNameSystem
&
memoryNameSystem
()
const
;
42
43
44
private
:
45
46
plugins::Plugin
* plugin =
nullptr
;
47
48
};
49
50
}
51
namespace
armarx::armem::client
52
{
53
using
PluginUser
=
plugins::PluginUser
;
54
}
55
namespace
armarx::armem
56
{
57
using
ClientPluginUser
=
client::PluginUser
;
58
}
armarx::armem::client::plugins::PluginUser::memoryNameSystem
MemoryNameSystem & memoryNameSystem()
Definition:
PluginUser.cpp:22
armarx::armem
Definition:
LegacyRobotStateMemoryAdapter.cpp:31
armarx::armem::client
This file is part of ArmarX.
Definition:
forward_declarations.h:7
armarx::armem::client::PluginUser
plugins::PluginUser PluginUser
Definition:
PluginUser.h:53
armarx::armem::client::plugins::PluginUser
Adds the Memory Name System client component plugin.
Definition:
PluginUser.h:29
forward_declarations.h
ManagedIceObject.h
armarx::ManagedIceObject
The ManagedIceObject is the base class for all ArmarX objects.
Definition:
ManagedIceObject.h:163
armarx::armem::client::plugins
This file is part of ArmarX.
Definition:
forward_declarations.h:24
armarx::armem::client::MemoryNameSystem
The memory name system (MNS) client.
Definition:
MemoryNameSystem.h:69
armarx::armem::client::plugins::PluginUser::PluginUser
PluginUser()
Definition:
PluginUser.cpp:11
plugins::Plugin
armarx::armem::client::plugins::PluginUser::~PluginUser
virtual ~PluginUser() override
Definition:
PluginUser.cpp:17
RobotAPI
libraries
armem
client
plugins
PluginUser.h
Generated on Sat Oct 12 2024 09:14:07 for armarx_documentation by
1.8.17