NJointHolonomicPlatformUnitVelocityPassThroughController.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::NJointHolonomicPlatformUnitVelocityPassThroughController
17  * @author Raphael Grimm ( raphael dot grimm at kit dot edu )
18  * @date 2017
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 #include <VirtualRobot/Robot.h>
26 
27 #include "../ControlTargets/ControlTargetHolonomicPlatformVelocity.h"
28 #include "../util.h"
30 
31 namespace armarx
32 {
33 
34  TYPEDEF_PTRS_HANDLE(NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig);
35 
37  virtual public NJointControllerConfig
38  {
39  public:
40  std::string platformName;
44  };
45 
47 
49  {
50  public:
51  float velocityX = 0;
52  float velocityY = 0;
53  float velocityRotation = 0;
55  };
56 
58 
59  /**
60  * @brief The NJointHolonomicPlatformUnitVelocityPassThroughController class
61  * @ingroup Library-RobotUnit-NJointControllers
62  */
64  virtual public NJointControllerWithTripleBuffer<
65  NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData>
66  {
67  public:
68  using ConfigPtrT = NJointHolonomicPlatformUnitVelocityPassThroughControllerConfigPtr;
69 
71  RobotUnit* prov,
72  NJointHolonomicPlatformUnitVelocityPassThroughControllerConfigPtr config,
73  const VirtualRobot::RobotPtr&);
74 
75  void rtRun(const IceUtil::Time&, const IceUtil::Time&) override;
76 
77  //for the platform unit
78  void setVelocites(float velocityX, float velocityY, float velocityRotation);
79 
80  //ice interface
81  std::string
82  getClassName(const Ice::Current& = Ice::emptyCurrent) const override
83  {
84  return "NJointHolonomicPlatformUnitVelocityPassThroughController";
85  }
86 
89 
90  protected:
92 
95  };
96 } // namespace armarx
armarx::ControlTargetHolonomicPlatformVelocity
Brief description of class ControlTargetHolonomicPlatformVelocity.
Definition: ControlTargetHolonomicPlatformVelocity.h:38
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::setMaxCommandDelay
void setMaxCommandDelay(const IceUtil::Time &value)
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.cpp:95
NJointControllerWithTripleBuffer.h
armarx::TYPEDEF_PTRS_HANDLE
TYPEDEF_PTRS_HANDLE(NJointCartesianNaturalPositionController)
armarx::NJointControllerWithTripleBuffer
Definition: NJointControllerWithTripleBuffer.h:10
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::NJointHolonomicPlatformUnitVelocityPassThroughController
NJointHolonomicPlatformUnitVelocityPassThroughController(RobotUnit *prov, NJointHolonomicPlatformUnitVelocityPassThroughControllerConfigPtr config, const VirtualRobot::RobotPtr &)
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.cpp:32
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:36
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController
The NJointHolonomicPlatformUnitVelocityPassThroughController class.
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:63
armarx::NJointControllerBase::ConfigPtrT
NJointControllerConfigPtr ConfigPtrT
Definition: NJointControllerBase.h:586
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::maxCommandDelay
IceUtil::Time maxCommandDelay
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:91
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::target
ControlTargetHolonomicPlatformVelocity * target
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:93
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData::velocityRotation
float velocityRotation
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:53
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::getMaxCommandDelay
IceUtil::Time getMaxCommandDelay() const
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.cpp:89
cxxopts::value
std::shared_ptr< Value > value()
Definition: cxxopts.hpp:926
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::initialSettings
NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData initialSettings
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:94
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData::commandTimestamp
IceUtil::Time commandTimestamp
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:54
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig::platformName
std::string platformName
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:40
armarx::armem::Time
armarx::core::time::DateTime Time
Definition: forward_declarations.h:13
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig::initialVelocityRotation
float initialVelocityRotation
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:43
armarx::RobotUnit
The RobotUnit class manages a robot and its controllers.
Definition: RobotUnit.h:180
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData::velocityX
float velocityX
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:51
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig::initialVelocityY
float initialVelocityY
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:42
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerConfig::initialVelocityX
float initialVelocityX
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:41
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::rtRun
void rtRun(const IceUtil::Time &, const IceUtil::Time &) override
TODO make protected and use attorneys.
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.cpp:51
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData::velocityY
float velocityY
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:52
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::setVelocites
void setVelocites(float velocityX, float velocityY, float velocityRotation)
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.cpp:76
armarx::NJointHolonomicPlatformUnitVelocityPassThroughControllerControlData
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:48
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28
VirtualRobot::RobotPtr
std::shared_ptr< class Robot > RobotPtr
Definition: Bus.h:18
armarx::NJointHolonomicPlatformUnitVelocityPassThroughController::getClassName
std::string getClassName(const Ice::Current &=Ice::emptyCurrent) const override
Definition: NJointHolonomicPlatformUnitVelocityPassThroughController.h:82