GeneralPurposeMemory.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::GeneralPurposeMemory
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 
27 
30 
32 
33 
34 namespace armarx
35 {
36  /**
37  * @defgroup Component-GeneralPurposeMemory GeneralPurposeMemory
38  * @ingroup RobotAPI-Components
39  * A description of the component GeneralPurposeMemory.
40  *
41  * @class GeneralPurposeMemory
42  * @ingroup Component-GeneralPurposeMemory
43  * @brief Brief description of class GeneralPurposeMemory.
44  *
45  * Detailed description of class GeneralPurposeMemory.
46  */
48  virtual public armarx::Component
49  , virtual public armem::server::ReadWritePluginUser
50  {
51  public:
52 
54 
55  /// @see armarx::ManagedIceObject::getDefaultName()
56  std::string getDefaultName() const override;
57 
58 
59  public:
60 
61  armem::data::AddSegmentsResult
62  addSegments(const armem::data::AddSegmentsInput& input, const Ice::Current&) override;
63 
64 
65  protected:
66 
67  /// @see PropertyUser::createPropertyDefinitions()
69 
70  /// @see armarx::ManagedIceObject::onInitComponent()
71  void onInitComponent() override;
72 
73  /// @see armarx::ManagedIceObject::onConnectComponent()
74  void onConnectComponent() override;
75 
76  /// @see armarx::ManagedIceObject::onDisconnectComponent()
77  void onDisconnectComponent() override;
78 
79  /// @see armarx::ManagedIceObject::onExitComponent()
80  void onExitComponent() override;
81 
82 
83  private:
84 
85  bool addCoreSegmentOnUsage = true;
86 
87  };
88 }
armarx::GeneralPurposeMemory::getDefaultName
std::string getDefaultName() const override
Definition: GeneralPurposeMemory.cpp:49
ArVizComponentPlugin.h
armarx::GeneralPurposeMemory::createPropertyDefinitions
armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: GeneralPurposeMemory.cpp:39
ReadWritePluginUser.h
LightweightRemoteGuiComponentPlugin.h
armarx::GeneralPurposeMemory::addSegments
armem::data::AddSegmentsResult addSegments(const armem::data::AddSegmentsInput &input, const Ice::Current &) override
Definition: GeneralPurposeMemory.cpp:76
armarx::GeneralPurposeMemory::GeneralPurposeMemory
GeneralPurposeMemory()
Definition: GeneralPurposeMemory.cpp:35
armarx::aron::input
ReaderT::InputType & input
Definition: rw.h:19
armarx::armem::server::plugins::ReadWritePluginUser
Base class of memory server components.
Definition: ReadWritePluginUser.h:20
armarx::GeneralPurposeMemory::onConnectComponent
void onConnectComponent() override
Definition: GeneralPurposeMemory.cpp:60
Component.h
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::GeneralPurposeMemory::onExitComponent
void onExitComponent() override
Definition: GeneralPurposeMemory.cpp:70
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::GeneralPurposeMemory::onDisconnectComponent
void onDisconnectComponent() override
Definition: GeneralPurposeMemory.cpp:65
armarx::GeneralPurposeMemory::onInitComponent
void onInitComponent() override
Definition: GeneralPurposeMemory.cpp:55
armarx::GeneralPurposeMemory
Brief description of class GeneralPurposeMemory.
Definition: GeneralPurposeMemory.h:47
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28