KITProstheticHandObserver.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::KITProstheticHandObserver
17  * @author Raphael Grimm ( raphael dot grimm at kit dot edu )
18  * @date 2018
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 
27 
28 namespace armarx
29 {
30  /**
31  * @class KITProstheticHandObserverPropertyDefinitions
32  * @brief
33  */
36  {
37  public:
40  {
41  //defineRequiredProperty<std::string>("PropertyName", "Description");
42  //defineOptionalProperty<std::string>("PropertyName", "DefaultValue", "Description");
43  }
44  };
45 
46  /**
47  * @defgroup Component-KITProstheticHandObserver KITProstheticHandObserver
48  * @ingroup RobotAPI-Components
49  * A description of the component KITProstheticHandObserver.
50  *
51  * @class KITProstheticHandObserver
52  * @ingroup Component-KITProstheticHandObserver
53  * @brief Brief description of class KITProstheticHandObserver.
54  *
55  * Detailed description of class KITProstheticHandObserver.
56  */
58  virtual public armarx::Component
59  {
60  public:
61  /**
62  * @see armarx::ManagedIceObject::getDefaultName()
63  */
64  std::string getDefaultName() const override
65  {
66  return "KITProstheticHandObserver";
67  }
68 
69  protected:
70  /**
71  * @see armarx::ManagedIceObject::onInitComponent()
72  */
73  void onInitComponent() override;
74 
75  /**
76  * @see armarx::ManagedIceObject::onConnectComponent()
77  */
78  void onConnectComponent() override;
79 
80  /**
81  * @see armarx::ManagedIceObject::onDisconnectComponent()
82  */
83  void onDisconnectComponent() override;
84 
85  /**
86  * @see armarx::ManagedIceObject::onExitComponent()
87  */
88  void onExitComponent() override;
89 
90  /**
91  * @see PropertyUser::createPropertyDefinitions()
92  */
94  };
95 }
armarx::KITProstheticHandObserver::getDefaultName
std::string getDefaultName() const override
Definition: KITProstheticHandObserver.h:64
armarx::KITProstheticHandObserver::onDisconnectComponent
void onDisconnectComponent() override
Definition: KITProstheticHandObserver.cpp:40
armarx::PropertyDefinitionContainer::prefix
std::string prefix
Prefix of the properties such as namespace, domain, component name, etc.
Definition: PropertyDefinitionContainer.h:333
armarx::KITProstheticHandObserver::onConnectComponent
void onConnectComponent() override
Definition: KITProstheticHandObserver.cpp:34
armarx::KITProstheticHandObserverPropertyDefinitions
Definition: KITProstheticHandObserver.h:34
armarx::KITProstheticHandObserver::onInitComponent
void onInitComponent() override
Definition: KITProstheticHandObserver.cpp:28
armarx::KITProstheticHandObserver
Brief description of class KITProstheticHandObserver.
Definition: KITProstheticHandObserver.h:57
Component.h
armarx::KITProstheticHandObserver::createPropertyDefinitions
armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: KITProstheticHandObserver.cpp:51
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::ComponentPropertyDefinitions
Default component property definition container.
Definition: Component.h:70
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::KITProstheticHandObserverPropertyDefinitions::KITProstheticHandObserverPropertyDefinitions
KITProstheticHandObserverPropertyDefinitions(std::string prefix)
Definition: KITProstheticHandObserver.h:38
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28
armarx::KITProstheticHandObserver::onExitComponent
void onExitComponent() override
Definition: KITProstheticHandObserver.cpp:46