PX4 ROS 2 Interface Library
Library to interface with PX4 from a companion computer using ROS 2
subscription.hpp
1 /****************************************************************************
2  * Copyright (c) 2023 PX4 Development Team.
3  * SPDX-License-Identifier: BSD-3-Clause
4  ****************************************************************************/
5 
6 #pragma once
7 
8 #include <px4_ros2/common/context.hpp>
9 #include <px4_ros2/common/exception.hpp>
10 
11 using namespace std::chrono_literals; // NOLINT
12 
13 namespace px4_ros2
14 {
22 template<typename RosMessageType>
24 {
25  using UpdateCallback = std::function<void (const RosMessageType &)>;
26 
27 public:
28  Subscription(Context & context, const std::string & topic)
29  : _node(context.node())
30  {
31  const std::string namespaced_topic = context.topicNamespacePrefix() + topic;
32  _subscription = _node.create_subscription<RosMessageType>(
33  namespaced_topic, rclcpp::QoS(1).best_effort(),
34  [this](const typename RosMessageType::UniquePtr msg) {
35  _last = *msg;
36  _last_message_time = _node.get_clock()->now();
37  for (const auto & callback : _callbacks) {
38  callback(_last);
39  }
40  });
41  }
42 
48  void onUpdate(const UpdateCallback & callback)
49  {
50  _callbacks.push_back(callback);
51  }
52 
59  const RosMessageType & last() const
60  {
61  if (!hasReceivedMessages()) {
62  throw Exception("No messages received.");
63  }
64  return _last;
65  }
66 
72  const rclcpp::Time & lastTime() const
73  {
74  return _last_message_time;
75  }
76 
84  template<typename DurationT = std::milli>
85  bool lastValid(const std::chrono::duration<int64_t, DurationT> max_delay = 500ms) const
86  {
87  return hasReceivedMessages() && _node.get_clock()->now() - _last_message_time < max_delay;
88  }
89 
90 protected:
91  rclcpp::Node & _node;
92 
93 private:
94  typename rclcpp::Subscription<RosMessageType>::SharedPtr _subscription{nullptr};
95 
96  RosMessageType _last;
97  rclcpp::Time _last_message_time;
98 
99  std::vector<std::function<void(const RosMessageType &)>> _callbacks{};
100 
101  bool hasReceivedMessages() const
102  {
103  return _last_message_time.seconds() != 0;
104  }
105 };
106 
108 } // namespace px4_ros2
Definition: context.hpp:20
Definition: exception.hpp:16
Provides a subscription to arbitrary ROS topics.
Definition: subscription.hpp:24
bool lastValid(const std::chrono::duration< int64_t, DurationT > max_delay=500ms) const
Check whether the last message is still valid. To be valid, the message must have been received withi...
Definition: subscription.hpp:85
void onUpdate(const UpdateCallback &callback)
Add a callback to execute when receiving a new message.
Definition: subscription.hpp:48
const RosMessageType & last() const
Get the last-received message.
Definition: subscription.hpp:59
const rclcpp::Time & lastTime() const
Get the receive-time of the last message.
Definition: subscription.hpp:72