SkillProviderExample.h
Go to the documentation of this file.
1 
2 /*
3  * This file is part of ArmarX.
4  *
5  * ArmarX is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * ArmarX is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  *
17  * @author Fabian Reister ( fabian dot reister at kit dot edu )
18  * @date 2021
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 
26 // ArmarX
28 
29 // RobotAPI
31 
32 #include "Callback.h"
33 #include "Chaining.h"
34 #include "HelloWorld.h"
35 #include "Incomplete.h"
36 #include "Segfault.h"
37 #include "Timeout.h"
38 
40 {
41  /**
42  * @defgroup Component-ExampleClient ExampleClient
43  * @ingroup RobotAPI-Components
44  * A description of the component ExampleClient.
45  *
46  * @class ExampleClient
47  * @ingroup Component-ExampleClient
48  * @brief Brief description of class ExampleClient.
49  *
50  * Detailed description of class ExampleClient.
51  */
53  virtual public armarx::Component,
55  {
56  public:
58 
59  /// @see armarx::ManagedIceObject::getDefaultName()
60  std::string getDefaultName() const override;
61 
62  protected:
64 
65  void onInitComponent() override;
66  void onConnectComponent() override;
67  void onDisconnectComponent() override;
68  void onExitComponent() override;
69 
70  private:
71  };
72 } // namespace armarx::skills::provider
SkillProviderComponentPlugin.h
armarx::skills::provider::SkillProviderExample
Definition: SkillProviderExample.h:52
armarx::skills::provider::SkillProviderExample::SkillProviderExample
SkillProviderExample()
Definition: SkillProviderExample.cpp:6
HelloWorld.h
Callback.h
armarx::SkillProviderComponentPluginUser
Definition: SkillProviderComponentPlugin.h:120
armarx::skills::provider::SkillProviderExample::onInitComponent
void onInitComponent() override
Pure virtual hook for the subclass.
Definition: SkillProviderExample.cpp:25
Incomplete.h
armarx::skills::provider::SkillProviderExample::onConnectComponent
void onConnectComponent() override
Pure virtual hook for the subclass.
Definition: SkillProviderExample.cpp:67
Segfault.h
armarx::skills::provider::SkillProviderExample::createPropertyDefinitions
armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: SkillProviderExample.cpp:11
armarx::skills::provider
Definition: Callback.cpp:4
Component.h
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::skills::provider::SkillProviderExample::onExitComponent
void onExitComponent() override
Hook for subclass.
Definition: SkillProviderExample.cpp:77
Timeout.h
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::skills::provider::SkillProviderExample::onDisconnectComponent
void onDisconnectComponent() override
Hook for subclass.
Definition: SkillProviderExample.cpp:72
armarx::skills::provider::SkillProviderExample::getDefaultName
std::string getDefaultName() const override
Definition: SkillProviderExample.cpp:19
Chaining.h