SubjectMemory.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::ArmarXObjects::ExampleMemory
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 
23 #pragma once
24 
25 
28 
29 #include <RobotAPI/libraries/armem_subjects/server/MotionDatabase/Segment.h>
30 
31 namespace armarx
32 {
33  /**
34  * @defgroup Component-ExampleMemory ExampleMemory
35  * @ingroup RobotAPI-Components
36  * A description of the component ExampleMemory.
37  *
38  * @class ExampleMemory
39  * @ingroup Component-ExampleMemory
40  * @brief Brief description of class ExampleMemory.
41  *
42  * Detailed description of class ExampleMemory.
43  */
44  class SubjectMemory :
45  virtual public armarx::Component
46  , virtual public armem::server::ReadWritePluginUser
47  {
48  public:
49 
50  SubjectMemory();
51 
52  /// @see armarx::ManagedIceObject::getDefaultName()
53  std::string getDefaultName() const override;
54 
55  protected:
56 
58 
59  void onInitComponent() override;
60  void onConnectComponent() override;
61  void onDisconnectComponent() override;
62  void onExitComponent() override;
63 
64 
65  private:
66  std::string memoryName = "Subject";
67 
68  armem::server::subjects::mdb::Segment mdbSubjects;
69 
70  };
71 }
ReadWritePluginUser.h
armarx::SubjectMemory::onExitComponent
void onExitComponent() override
Hook for subclass.
Definition: SubjectMemory.cpp:70
armarx::SubjectMemory::onInitComponent
void onInitComponent() override
Pure virtual hook for the subclass.
Definition: SubjectMemory.cpp:56
armarx::SubjectMemory
Definition: SubjectMemory.h:44
armarx::SubjectMemory::onConnectComponent
void onConnectComponent() override
Pure virtual hook for the subclass.
Definition: SubjectMemory.cpp:62
armarx::armem::server::plugins::ReadWritePluginUser
Base class of memory server components.
Definition: ReadWritePluginUser.h:20
Component.h
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::SubjectMemory::getDefaultName
std::string getDefaultName() const override
Definition: SubjectMemory.cpp:51
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::SubjectMemory::onDisconnectComponent
void onDisconnectComponent() override
Hook for subclass.
Definition: SubjectMemory.cpp:66
armarx::SubjectMemory::createPropertyDefinitions
armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: SubjectMemory.cpp:34
armarx::SubjectMemory::SubjectMemory
SubjectMemory()
Definition: SubjectMemory.cpp:44
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28