PlatformGlobalTrajectoryController.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 <Ice/Current.h>
30 #include <Ice/Object.h>
31 #include <IceUtil/Time.h>
32 
33 #include <VirtualRobot/VirtualRobot.h>
34 
35 #include <ArmarXCore/interface/observers/ObserverInterface.h>
37 
40 #include <RobotAPI/interface/aron/Aron.h>
41 #include <RobotAPI/interface/units/RobotUnit/NJointController.h>
42 #include <RobotAPI/interface/visualization/DebugDrawerInterface.h>
43 
44 #include <armarx/control/interface/ConfigurableNJointControllerInterface.h>
47 
48 namespace armarx
49 {
50  class ControlTargetHolonomicPlatformVelocity;
51  class SensorValueHolonomicPlatformWithAbsolutePosition;
52 } // namespace armarx
53 
55 {
56  struct Targets
57  {
59  };
60 
61  struct Config
62  {
64 
67  };
68 
69  struct Twist2D
70  {
71  Eigen::Vector2f linear = Eigen::Vector2f::Zero();
72  float angular = 0;
73 
74  void
76  {
77  linear = Eigen::Vector2f::Zero();
78  angular = 0;
79  }
80  };
81 
82  using Target = Twist2D;
83 
84  struct Debug
85  {
87 
88  double dropPointVelocity = 0;
89  double currentOrientation = 0;
90  double desiredOrientation = 0;
91  double orientationError = 0;
92  bool isFinalSegment = false;
93 
94  double positionError = 0;
95  };
96 
97  struct Devices
98  {
100  };
101 
102  using NameValueMap = std::map<std::string, float>;
103 
104  class Controller :
105  virtual public NJointControllerWithTripleBuffer<Target>,
106  virtual public armarx::control::ConfigurableNJointControllerInterface
107  {
108  public:
109  using ConfigPtrT = control::ConfigurableNJointControllerConfigPtr;
110 
111  Controller(const RobotUnitPtr& robotUnit,
112  const NJointControllerConfigPtr& config,
113  const VirtualRobot::RobotPtr&);
114 
115  ~Controller() override;
116 
117  std::string getClassName(const Ice::Current& iceCurrent = Ice::emptyCurrent) const override;
118 
119  void rtRun(const IceUtil::Time& sensorValuesTimestamp,
120  const IceUtil::Time& timeSinceLastIteration) override;
121 
123  const Ice::Current& iceCurrent = Ice::emptyCurrent) override;
124 
126  getConfig(const ::Ice::Current& = ::Ice::emptyCurrent) override;
127 
128  protected:
129  void additionalTask();
130  void onPublish(const SensorAndControl& sac,
131  const DebugDrawerInterfacePrx& debugDrawer,
132  const DebugObserverInterfacePrx& debugObservers) override;
133 
134 
135  void onInitNJointController() override;
136  void rtPreActivateController() override;
137  void rtPostDeactivateController() override;
138 
139  private:
140  struct RobotState
141  {
142  Eigen::Isometry3f global_T_robot;
143  };
144 
145  TripleBuffer<Config> configBuffer_updateConfigToAdditionalTask;
146  TripleBuffer<Config> configBuffer_updateConfigToOnPublish;
147  TripleBuffer<Debug> targetBuffer_additionalTaskToOnPublish;
148  TripleBuffer<RobotState> robotStateBuffer_rtToAdditionalTask;
149 
150 
151  // internal
152  std::atomic_bool rtFirstRun = true;
153  std::atomic_bool rtReady = false;
154 
156 
157  std::optional<traj_ctrl::global::TrajectoryFollowingController>
158  trajectoryFollowingController;
159 
160 
161  Devices getDevices(const VirtualRobot::RobotNodeSet& rns);
162 
163  // additional task has exclusive access to this variable
164  Twist2D filteredTwist;
165  };
166 
167 } // namespace armarx::navigation::platform_controller::platform_global_trajectory
armarx::navigation::platform_controller::platform_global_trajectory::Debug::isFinalSegment
bool isFinalSegment
Definition: PlatformGlobalTrajectoryController.h:92
armarx::navigation::core::GlobalTrajectory
Definition: Trajectory.h:70
armarx::ControlTargetHolonomicPlatformVelocity
Brief description of class ControlTargetHolonomicPlatformVelocity.
Definition: ControlTargetHolonomicPlatformVelocity.h:38
armarx::navigation::platform_controller::platform_global_trajectory::Twist2D::reset
void reset()
Definition: PlatformGlobalTrajectoryController.h:75
NJointControllerWithTripleBuffer.h
NJointControllerBase.h
armarx::NJointControllerWithTripleBuffer
Definition: NJointControllerWithTripleBuffer.h:10
armarx::navigation::platform_controller::platform_global_trajectory::Debug::dropPointVelocity
double dropPointVelocity
Definition: PlatformGlobalTrajectoryController.h:88
armarx::navigation::platform_controller::platform_global_trajectory::Targets
Definition: PlatformGlobalTrajectoryController.h:56
armarx::navigation::platform_controller::platform_global_trajectory::Controller::updateConfig
void updateConfig(const ::armarx::aron::data::dto::DictPtr &dto, const Ice::Current &iceCurrent=Ice::emptyCurrent) override
Definition: PlatformGlobalTrajectoryController.cpp:107
armarx::navigation::platform_controller::platform_global_trajectory::Debug::currentOrientation
double currentOrientation
Definition: PlatformGlobalTrajectoryController.h:89
armarx::NJointControllerBase::ConfigPtrT
NJointControllerConfigPtr ConfigPtrT
Definition: NJointControllerBase.h:587
TrajectoryFollowingController.h
armarx::navigation::platform_controller::platform_global_trajectory::Controller::onInitNJointController
void onInitNJointController() override
Definition: PlatformGlobalTrajectoryController.cpp:221
armarx::navigation::platform_controller::platform_global_trajectory::NameValueMap
std::map< std::string, float > NameValueMap
Definition: PlatformGlobalTrajectoryController.h:102
armarx::navigation::platform_controller::platform_global_trajectory::Config
Definition: PlatformGlobalTrajectoryController.h:61
armarx::navigation::platform_controller::platform_global_trajectory::Controller::additionalTask
void additionalTask()
Definition: PlatformGlobalTrajectoryController.cpp:124
IceInternal::Handle
Definition: forward_declarations.h:8
armarx::detail::ControlThreadOutputBufferEntry
Definition: ControlThreadOutputBuffer.h:182
armarx::navigation::platform_controller::platform_global_trajectory::Twist2D
Definition: PlatformGlobalTrajectoryController.h:69
armarx::navigation::platform_controller::platform_global_trajectory::Controller::Controller
Controller(const RobotUnitPtr &robotUnit, const NJointControllerConfigPtr &config, const VirtualRobot::RobotPtr &)
Definition: PlatformGlobalTrajectoryController.cpp:38
armarx::navigation::platform_controller::platform_global_trajectory::Targets::trajectory
core::GlobalTrajectory trajectory
Definition: PlatformGlobalTrajectoryController.h:58
armarx::navigation::platform_controller::platform_global_trajectory::Controller::getConfig
::armarx::aron::data::dto::DictPtr getConfig(const ::Ice::Current &=::Ice::emptyCurrent) override
Definition: PlatformGlobalTrajectoryController.cpp:270
armarx::navigation::platform_controller::platform_global_trajectory::Controller::getClassName
std::string getClassName(const Ice::Current &iceCurrent=Ice::emptyCurrent) const override
Definition: PlatformGlobalTrajectoryController.cpp:83
armarx::navigation::platform_controller::platform_global_trajectory::Config::params
Params params
Definition: PlatformGlobalTrajectoryController.h:65
armarx::navigation::platform_controller::platform_global_trajectory::Controller::rtPostDeactivateController
void rtPostDeactivateController() override
This function is called after the controller is deactivated.
Definition: PlatformGlobalTrajectoryController.cpp:262
armarx::navigation::platform_controller::platform_global_trajectory::Twist2D::angular
float angular
Definition: PlatformGlobalTrajectoryController.h:72
armarx::navigation::platform_controller::platform_global_trajectory::Debug::orientationError
double orientationError
Definition: PlatformGlobalTrajectoryController.h:91
armarx::armem::Time
armarx::core::time::DateTime Time
Definition: forward_declarations.h:13
armarx::navigation::platform_controller::platform_global_trajectory::Devices
Definition: PlatformGlobalTrajectoryController.h:97
armarx::aron::data::DictPtr
std::shared_ptr< Dict > DictPtr
Definition: Dict.h:41
TripleBuffer.h
armarx::navigation::traj_ctrl::global::TrajectoryFollowingControllerParams
Definition: TrajectoryFollowingController.h:40
armarx::navigation::platform_controller::platform_global_trajectory::Controller::rtRun
void rtRun(const IceUtil::Time &sensorValuesTimestamp, const IceUtil::Time &timeSinceLastIteration) override
TODO make protected and use attorneys.
Definition: PlatformGlobalTrajectoryController.cpp:90
armarx::navigation::platform_controller::platform_global_trajectory::Controller::rtPreActivateController
void rtPreActivateController() override
This function is called before the controller is activated.
Definition: PlatformGlobalTrajectoryController.cpp:249
IceUtil::Handle< class RobotUnit >
armarx::navigation::platform_controller::platform_global_trajectory::Debug::desiredOrientation
double desiredOrientation
Definition: PlatformGlobalTrajectoryController.h:90
IceInternal::ProxyHandle<::IceProxy::armarx::DebugDrawerInterface >
armarx::navigation::platform_controller::platform_global_trajectory::Twist2D::linear
Eigen::Vector2f linear
Definition: PlatformGlobalTrajectoryController.h:71
armarx::navigation::platform_controller::platform_global_trajectory::Debug::positionError
double positionError
Definition: PlatformGlobalTrajectoryController.h:94
armarx::navigation::platform_controller::platform_global_trajectory::Controller::~Controller
~Controller() override
armarx::navigation::platform_controller::platform_global_trajectory::Debug::target
Target target
Definition: PlatformGlobalTrajectoryController.h:86
armarx::navigation::platform_controller::platform_global_trajectory::Config::targets
Targets targets
Definition: PlatformGlobalTrajectoryController.h:66
armarx::navigation::platform_controller::platform_global_trajectory::Debug
Definition: PlatformGlobalTrajectoryController.h:84
Trajectory.h
armarx::navigation::platform_controller::platform_global_trajectory
Definition: aron_conversions.cpp:35
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::navigation::platform_controller::platform_global_trajectory::Controller::onPublish
void onPublish(const SensorAndControl &sac, const DebugDrawerInterfacePrx &debugDrawer, const DebugObserverInterfacePrx &debugObservers) override
Definition: PlatformGlobalTrajectoryController.cpp:187
armarx::navigation::platform_controller::platform_global_trajectory::Devices::platformTarget
ControlTargetHolonomicPlatformVelocity * platformTarget
Definition: PlatformGlobalTrajectoryController.h:99
VirtualRobot::RobotPtr
std::shared_ptr< class Robot > RobotPtr
Definition: Bus.h:19
armarx::navigation::platform_controller::platform_global_trajectory::Controller
Definition: PlatformGlobalTrajectoryController.h:104
armarx::TripleBuffer< Config >