Nav2 Navigation Stack - lyrical  lyrical
ROS 2 Navigation Stack
twist_subscriber.hpp
1 // Copyright (C) 2023 Ryan Friedman
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 
16 #ifndef NAV2_UTIL__TWIST_SUBSCRIBER_HPP_
17 #define NAV2_UTIL__TWIST_SUBSCRIBER_HPP_
18 
19 
20 #include <memory>
21 #include <string>
22 #include <utility>
23 
24 #include "geometry_msgs/msg/twist.hpp"
25 #include "geometry_msgs/msg/twist_stamped.hpp"
26 #include "rclcpp/parameter_service.hpp"
27 #include "rclcpp/qos.hpp"
28 
29 #include "nav2_ros_common/lifecycle_node.hpp"
30 #include "nav2_ros_common/node_utils.hpp"
31 
32 namespace nav2_util
33 {
34 
70 {
71 public:
80  template<typename TwistCallbackT,
81  typename TwistStampedCallbackT
82  >
83  explicit TwistSubscriber(
84  nav2::LifecycleNode::SharedPtr node,
85  const std::string & topic,
86  TwistCallbackT && TwistCallback,
87  TwistStampedCallbackT && TwistStampedCallback,
88  const rclcpp::QoS & qos = nav2::qos::StandardTopicQoS()
89  )
90  {
91  is_stamped_ = node->declare_or_get_parameter("enable_stamped_cmd_vel", true);
92  if (is_stamped_) {
93  twist_stamped_sub_ = node->create_subscription<geometry_msgs::msg::TwistStamped>(
94  topic,
95  std::forward<TwistStampedCallbackT>(TwistStampedCallback),
96  qos);
97  } else {
98  twist_sub_ = node->create_subscription<geometry_msgs::msg::Twist>(
99  topic,
100  std::forward<TwistCallbackT>(TwistCallback),
101  qos);
102  }
103  }
104 
113  template<typename TwistStampedCallbackT>
114  explicit TwistSubscriber(
115  nav2::LifecycleNode::SharedPtr node,
116  const std::string & topic,
117  TwistStampedCallbackT && TwistStampedCallback,
118  const rclcpp::QoS & qos = nav2::qos::StandardTopicQoS()
119  )
120  {
121  is_stamped_ = node->declare_or_get_parameter("enable_stamped_cmd_vel", true);
122  if (is_stamped_) {
123  twist_stamped_sub_ = node->create_subscription<geometry_msgs::msg::TwistStamped>(
124  topic,
125  std::forward<TwistStampedCallbackT>(TwistStampedCallback),
126  qos);
127  } else {
128  throw std::invalid_argument(
129  "enable_stamped_cmd_vel must be true when using this constructor!");
130  }
131  }
132 
133 protected:
135  bool is_stamped_{true};
137  nav2::Subscription<geometry_msgs::msg::Twist>::SharedPtr twist_sub_ {nullptr};
139  nav2::Subscription<geometry_msgs::msg::TwistStamped>::SharedPtr twist_stamped_sub_ {nullptr};
140 };
141 
142 
143 } // namespace nav2_util
144 
145 #endif // NAV2_UTIL__TWIST_SUBSCRIBER_HPP_
A QoS profile for standard reliable topics with a history of 10 messages.
A simple wrapper on a Twist subscriber that receives either geometry_msgs::msg::TwistStamped or geome...
TwistSubscriber(nav2::LifecycleNode::SharedPtr node, const std::string &topic, TwistStampedCallbackT &&TwistStampedCallback, const rclcpp::QoS &qos=nav2::qos::StandardTopicQoS())
A constructor that only supports TwistStamped.
bool is_stamped_
The user-configured value for ROS parameter enable_stamped_cmd_vel.
nav2::Subscription< geometry_msgs::msg::Twist >::SharedPtr twist_sub_
The subscription when using Twist.
nav2::Subscription< geometry_msgs::msg::TwistStamped >::SharedPtr twist_stamped_sub_
The subscription when using TwistStamped.
TwistSubscriber(nav2::LifecycleNode::SharedPtr node, const std::string &topic, TwistCallbackT &&TwistCallback, TwistStampedCallbackT &&TwistStampedCallback, const rclcpp::QoS &qos=nav2::qos::StandardTopicQoS())
A constructor that supports either Twist and TwistStamped.