MultiHandUnit.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::MultiHandUnit
17  * @author Raphael Grimm ( raphael dot grimm at kit dot edu )
18  * @date 2019
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
26 
27 #include <RobotAPI/interface/units/MultiHandUnitInterface.h>
28 
29 
30 namespace armarx
31 {
32  /**
33  * @class MultiHandUnitPropertyDefinitions
34  * @brief
35  */
38  {
39  public:
41  };
42 
43 
44 
45  /**
46  * @defgroup Component-MultiHandUnit MultiHandUnit
47  * @ingroup RobotAPI-Components
48  * A description of the component MultiHandUnit.
49  *
50  * @class MultiHandUnit
51  * @ingroup Component-MultiHandUnit
52  * @brief Brief description of class MultiHandUnit.
53  *
54  * Detailed description of class MultiHandUnit.
55  */
56  class MultiHandUnit :
57  virtual public armarx::Component,
58  virtual public MultiHandUnitInterface
59  {
60  public:
61 
62  /// @see armarx::ManagedIceObject::getDefaultName()
63  virtual std::string getDefaultName() const override;
64 
65 
66  protected:
67 
68  /// @see armarx::ManagedIceObject::onInitComponent()
69  virtual void onInitComponent() override;
70 
71  /// @see armarx::ManagedIceObject::onConnectComponent()
72  virtual void onConnectComponent() override;
73 
74  /// @see armarx::ManagedIceObject::onDisconnectComponent()
75  virtual void onDisconnectComponent() override;
76 
77  /// @see armarx::ManagedIceObject::onExitComponent()
78  virtual void onExitComponent() override;
79 
80  /// @see PropertyUser::createPropertyDefinitions()
82 
83  HandInfoSeq getHandInfos(const Ice::Current& = Ice::emptyCurrent) override;
84  void setJointValues(const std::string& handName, const NameValueMap& jointValues, const Ice::Current& = Ice::emptyCurrent) override;
85  NameValueMap getJointValues(const std::string& handName, const Ice::Current& = Ice::emptyCurrent) override;
86  private:
87  HandInfoSeq _handInfos;
88  std::map<std::string, HandUnitInterfacePrx> _hands;
89  };
90 }
armarx::MultiHandUnit
Brief description of class MultiHandUnit.
Definition: MultiHandUnit.h:56
armarx::MultiHandUnit::onConnectComponent
virtual void onConnectComponent() override
Definition: MultiHandUnit.cpp:57
armarx::PropertyDefinitionContainer::prefix
std::string prefix
Prefix of the properties such as namespace, domain, component name, etc.
Definition: PropertyDefinitionContainer.h:333
armarx::MultiHandUnit::getJointValues
NameValueMap getJointValues(const std::string &handName, const Ice::Current &=Ice::emptyCurrent) override
Definition: MultiHandUnit.cpp:93
armarx::MultiHandUnitPropertyDefinitions
Definition: MultiHandUnit.h:36
armarx::MultiHandUnitPropertyDefinitions::MultiHandUnitPropertyDefinitions
MultiHandUnitPropertyDefinitions(std::string prefix)
Definition: MultiHandUnit.cpp:28
armarx::MultiHandUnit::onDisconnectComponent
virtual void onDisconnectComponent() override
Definition: MultiHandUnit.cpp:67
armarx::MultiHandUnit::getDefaultName
virtual std::string getDefaultName() const override
Definition: MultiHandUnit.cpp:35
armarx::MultiHandUnit::onInitComponent
virtual void onInitComponent() override
Definition: MultiHandUnit.cpp:41
armarx::MultiHandUnit::onExitComponent
virtual void onExitComponent() override
Definition: MultiHandUnit.cpp:72
armarx::MultiHandUnit::createPropertyDefinitions
virtual armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
Definition: MultiHandUnit.cpp:77
armarx::MultiHandUnit::setJointValues
void setJointValues(const std::string &handName, const NameValueMap &jointValues, const Ice::Current &=Ice::emptyCurrent) override
Definition: MultiHandUnit.cpp:88
Component.h
armarx::Component
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition: Component.h:95
armarx::control::njoint_controller::platform::platform_follower_controller::NameValueMap
std::map< std::string, float > NameValueMap
Definition: PlatformFollowerController.h:91
armarx::ComponentPropertyDefinitions
Default component property definition container.
Definition: Component.h:70
armarx::MultiHandUnit::getHandInfos
HandInfoSeq getHandInfos(const Ice::Current &=Ice::emptyCurrent) override
Definition: MultiHandUnit.cpp:83
IceUtil::Handle< class PropertyDefinitionContainer >
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28