PlatformLocalTrajectoryController.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  * @author Fabian Reister ( fabian dot reister at kit dot edu )
17  * @date 2022
18  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
19  * GNU General Public License
20  */
21 
22 #pragma once
23 
24 #include <atomic>
25 #include <map>
26 #include <optional>
27 #include <string>
28 
29 #include <Eigen/Geometry>
30 
31 #include <Ice/Current.h>
32 #include <Ice/Object.h>
33 #include <IceUtil/Time.h>
34 
35 #include <VirtualRobot/VirtualRobot.h>
36 
37 #include <ArmarXCore/interface/observers/ObserverInterface.h>
39 
42 #include <RobotAPI/interface/aron/Aron.h>
43 #include <RobotAPI/interface/units/RobotUnit/NJointController.h>
44 #include <RobotAPI/interface/visualization/DebugDrawerInterface.h>
45 
46 #include <armarx/control/interface/ConfigurableNJointControllerInterface.h>
49 
50 namespace armarx
51 {
52  class ControlTargetHolonomicPlatformVelocity;
53  class SensorValueHolonomicPlatformWithAbsolutePosition;
54 } // namespace armarx
55 
57 {
58  struct Targets
59  {
61  };
62 
63  struct Config
64  {
66 
69  };
70 
71  struct Twist2D
72  {
73  Eigen::Vector2f linear = Eigen::Vector2f::Zero();
74  float angular = 0;
75 
76  void
78  {
79  linear = Eigen::Vector2f::Zero();
80  angular = 0;
81  }
82  };
83 
84  using Target = Twist2D;
85 
86  struct Devices
87  {
89  };
90 
91  using NameValueMap = std::map<std::string, float>;
92 
93  class Controller :
94  virtual public NJointControllerWithTripleBuffer<Target>,
95  virtual public armarx::control::ConfigurableNJointControllerInterface
96  {
97  public:
98  using ConfigPtrT = control::ConfigurableNJointControllerConfigPtr;
99 
100  Controller(const RobotUnitPtr& robotUnit,
101  const NJointControllerConfigPtr& config,
102  const VirtualRobot::RobotPtr&);
103 
104  ~Controller() override;
105 
106  std::string getClassName(const Ice::Current& iceCurrent = Ice::emptyCurrent) const override;
107 
108  void rtRun(const IceUtil::Time& sensorValuesTimestamp,
109  const IceUtil::Time& timeSinceLastIteration) override;
110 
112  const Ice::Current& iceCurrent = Ice::emptyCurrent) override;
113 
115  getConfig(const ::Ice::Current& = ::Ice::emptyCurrent) override;
116 
117  protected:
118  void additionalTask();
119  void onPublish(const SensorAndControl& sac,
120  const DebugDrawerInterfacePrx& debugDrawer,
121  const DebugObserverInterfacePrx& debugObservers) override;
122 
123 
124  void onInitNJointController() override;
125  void rtPreActivateController() override;
126  void rtPostDeactivateController() override;
127 
128  private:
129  struct RobotState
130  {
131  Eigen::Isometry3f global_T_robot;
132  };
133 
134  TripleBuffer<Config> configBuffer_updateConfigToAdditionalTask;
135  TripleBuffer<Config> configBuffer_updateConfigToOnPublish;
136  TripleBuffer<Target> targetBuffer_additionalTaskToOnPublish;
137  TripleBuffer<RobotState> robotStateBuffer_rtToAdditionalTask;
138 
139  // internal
140  std::atomic_bool rtFirstRun = true;
141  std::atomic_bool rtReady = false;
142 
144 
145  std::optional<traj_ctrl::local::TrajectoryFollowingController>
146  trajectoryFollowingController;
147 
148 
149  Devices getDevices(const VirtualRobot::RobotNodeSet& rns);
150 
151 
152  // additional task has exclusive access to this variable
153  Twist2D filteredTwist;
154  };
155 
156 } // namespace armarx::navigation::platform_controller::platform_local_trajectory
armarx::ControlTargetHolonomicPlatformVelocity
Brief description of class ControlTargetHolonomicPlatformVelocity.
Definition: ControlTargetHolonomicPlatformVelocity.h:38
NJointControllerWithTripleBuffer.h
armarx::navigation::platform_controller::platform_local_trajectory::Config::targets
Targets targets
Definition: PlatformLocalTrajectoryController.h:68
NJointControllerBase.h
armarx::navigation::platform_controller::platform_local_trajectory::Controller::rtPostDeactivateController
void rtPostDeactivateController() override
This function is called after the controller is deactivated.
Definition: PlatformLocalTrajectoryController.cpp:219
armarx::navigation::traj_ctrl::local::TrajectoryFollowingControllerParams
Definition: TrajectoryFollowingController.h:40
armarx::NJointControllerWithTripleBuffer
Definition: NJointControllerWithTripleBuffer.h:10
armarx::navigation::platform_controller::platform_local_trajectory::Config
Definition: PlatformLocalTrajectoryController.h:63
armarx::navigation::platform_controller::platform_local_trajectory::Twist2D::linear
Eigen::Vector2f linear
Definition: PlatformLocalTrajectoryController.h:73
armarx::navigation::platform_controller::platform_local_trajectory::Targets
Definition: PlatformLocalTrajectoryController.h:58
armarx::NJointControllerBase::ConfigPtrT
NJointControllerConfigPtr ConfigPtrT
Definition: NJointControllerBase.h:587
armarx::navigation::platform_controller::platform_local_trajectory::Devices::platformTarget
ControlTargetHolonomicPlatformVelocity * platformTarget
Definition: PlatformLocalTrajectoryController.h:88
armarx::navigation::platform_controller::platform_local_trajectory::Controller
Definition: PlatformLocalTrajectoryController.h:93
armarx::navigation::platform_controller::platform_local_trajectory::Controller::onInitNJointController
void onInitNJointController() override
Definition: PlatformLocalTrajectoryController.cpp:183
IceInternal::Handle
Definition: forward_declarations.h:8
armarx::detail::ControlThreadOutputBufferEntry
Definition: ControlThreadOutputBuffer.h:182
armarx::navigation::platform_controller::platform_local_trajectory::Controller::additionalTask
void additionalTask()
Definition: PlatformLocalTrajectoryController.cpp:118
TrajectoryFollowingController.h
armarx::navigation::platform_controller::platform_local_trajectory::Controller::onPublish
void onPublish(const SensorAndControl &sac, const DebugDrawerInterfacePrx &debugDrawer, const DebugObserverInterfacePrx &debugObservers) override
Definition: PlatformLocalTrajectoryController.cpp:161
armarx::navigation::core::LocalTrajectory
Definition: Trajectory.h:170
armarx::navigation::platform_controller::platform_local_trajectory::Devices
Definition: PlatformLocalTrajectoryController.h:86
armarx::navigation::platform_controller::platform_local_trajectory::Controller::updateConfig
void updateConfig(const ::armarx::aron::data::dto::DictPtr &dto, const Ice::Current &iceCurrent=Ice::emptyCurrent) override
Definition: PlatformLocalTrajectoryController.cpp:97
armarx::navigation::platform_controller::platform_local_trajectory::Controller::getClassName
std::string getClassName(const Ice::Current &iceCurrent=Ice::emptyCurrent) const override
Definition: PlatformLocalTrajectoryController.cpp:73
armarx::armem::Time
armarx::core::time::DateTime Time
Definition: forward_declarations.h:13
armarx::navigation::platform_controller::platform_local_trajectory::Twist2D::reset
void reset()
Definition: PlatformLocalTrajectoryController.h:77
armarx::navigation::platform_controller::platform_local_trajectory::Controller::rtPreActivateController
void rtPreActivateController() override
This function is called before the controller is activated.
Definition: PlatformLocalTrajectoryController.cpp:206
armarx::navigation::platform_controller::platform_local_trajectory::Controller::rtRun
void rtRun(const IceUtil::Time &sensorValuesTimestamp, const IceUtil::Time &timeSinceLastIteration) override
TODO make protected and use attorneys.
Definition: PlatformLocalTrajectoryController.cpp:80
armarx::aron::data::DictPtr
std::shared_ptr< Dict > DictPtr
Definition: Dict.h:41
TripleBuffer.h
armarx::navigation::platform_controller::platform_local_trajectory::NameValueMap
std::map< std::string, float > NameValueMap
Definition: PlatformLocalTrajectoryController.h:91
armarx::navigation::platform_controller::platform_local_trajectory::Controller::~Controller
~Controller() override
IceUtil::Handle< class RobotUnit >
IceInternal::ProxyHandle<::IceProxy::armarx::DebugDrawerInterface >
armarx::navigation::platform_controller::platform_local_trajectory::Twist2D::angular
float angular
Definition: PlatformLocalTrajectoryController.h:74
armarx::navigation::platform_controller::platform_local_trajectory::Twist2D
Definition: PlatformLocalTrajectoryController.h:71
armarx::navigation::platform_controller::platform_local_trajectory::Controller::getConfig
::armarx::aron::data::dto::DictPtr getConfig(const ::Ice::Current &=::Ice::emptyCurrent) override
Definition: PlatformLocalTrajectoryController.cpp:227
Trajectory.h
armarx::navigation::platform_controller::platform_local_trajectory::Targets::trajectory
core::LocalTrajectory trajectory
Definition: PlatformLocalTrajectoryController.h:60
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::navigation::platform_controller::platform_local_trajectory::Config::params
Params params
Definition: PlatformLocalTrajectoryController.h:67
VirtualRobot::RobotPtr
std::shared_ptr< class Robot > RobotPtr
Definition: Bus.h:19
armarx::TripleBuffer< Config >
armarx::navigation::platform_controller::platform_local_trajectory::Controller::Controller
Controller(const RobotUnitPtr &robotUnit, const NJointControllerConfigPtr &config, const VirtualRobot::RobotPtr &)
Definition: PlatformLocalTrajectoryController.cpp:37
armarx::navigation::platform_controller::platform_local_trajectory
Definition: aron_conversions.cpp:53