MotionMemory.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 
26 
28 
30 
32 
33 
34 namespace armarx
35 {
36  /**
37  * @defgroup Component-ExampleMemory ExampleMemory
38  * @ingroup RobotAPI-Components
39  * A description of the component ExampleMemory.
40  *
41  * @class ExampleMemory
42  * @ingroup Component-ExampleMemory
43  * @brief Brief description of class ExampleMemory.
44  *
45  * Detailed description of class ExampleMemory.
46  */
47  class MotionMemory :
48  virtual public armarx::Component
49  , virtual public armem::server::ReadWritePluginUser
50  {
51  public:
52 
53  MotionMemory();
54 
55  /// @see armarx::ManagedIceObject::getDefaultName()
56  std::string getDefaultName() const override;
57 
58 
59  protected:
60 
62 
63  void onInitComponent() override;
64  void onConnectComponent() override;
65  void onDisconnectComponent() override;
66  void onExitComponent() override;
67 
68 
69  private:
70 
73  // TODO: mdt Segment
74 
75  };
76 }
MotionSegment.h
ReadWritePluginUser.h
Segment.h
armarx::MotionMemory::onInitComponent
void onInitComponent() override
Pure virtual hook for the subclass.
Definition: MotionMemory.cpp:54
armarx::MotionMemory
Definition: MotionMemory.h:47
armarx::MotionMemory::getDefaultName
std::string getDefaultName() const override
Definition: MotionMemory.cpp:48
armarx::armem::server::motions::mdb::segment::MDBMotionSegment
Definition: MotionSegment.h:17
armarx::armem::server::plugins::ReadWritePluginUser
Base class of memory server components.
Definition: ReadWritePluginUser.h:20
armarx::MotionMemory::onConnectComponent
void onConnectComponent() override
Pure virtual hook for the subclass.
Definition: MotionMemory.cpp:61
armarx::MotionMemory::onExitComponent
void onExitComponent() override
Hook for subclass.
Definition: MotionMemory.cpp:73
Component.h
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::armem::server::motions::mps::segment::MPSegment
Definition: Segment.h:15
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::MotionMemory::createPropertyDefinitions
armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: MotionMemory.cpp:28
armarx::MotionMemory::onDisconnectComponent
void onDisconnectComponent() override
Hook for subclass.
Definition: MotionMemory.cpp:68
armarx::MotionMemory::MotionMemory
MotionMemory()
Definition: MotionMemory.cpp:41
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28