Modify getters naming, add docblocks

Signed-off-by: Ivan Santiago Paunovic <[email protected]>

Author: ivanpauno

rclcpp/include/rclcpp/qos.hpp

@@ -201,32 +201,41 @@ class RCLCPP_PUBLIC QoS
   QoS &
   avoid_ros_namespace_conventions(bool avoid_ros_namespace_conventions);
 
+  /// Get the history qos policy.
   HistoryPolicy
-  get_history() const;
+  history() const;
 
+  /// Get the history depth.
   size_t
-  get_depth() const;
+  depth() const;
 
+  /// Get the reliability policy.
   ReliabilityPolicy
-  get_reliability() const;
+  reliability() const;
 
+  /// Get the durability policy.
   DurabilityPolicy
-  get_durability() const;
+  durability() const;
 
+  /// Get the deadline duration setting.
   rclcpp::Duration
-  get_deadline() const;
+  deadline() const;
 
+  /// Get the lifespan duration setting.
   rclcpp::Duration
-  get_lifespan() const;
+  lifespan() const;
 
+  /// Get the liveliness policy.
   LivelinessPolicy
-  get_liveliness() const;
+  liveliness() const;
 
+  /// Get the liveliness lease duration setting.
   rclcpp::Duration
-  get_liveliness_lease_duration() const;
+  liveliness_lease_duration() const;
 
+  /// Get the `avoid ros namespace convention` setting.
   bool
-  get_avoid_ros_namespace_conventions() const;
+  avoid_ros_namespace_conventions() const;
 
 private:
   rmw_qos_profile_t rmw_qos_profile_;

rclcpp/src/rclcpp/qos.cpp

@@ -236,46 +236,46 @@ QoS::avoid_ros_namespace_conventions(bool avoid_ros_namespace_conventions)
 }
 
 HistoryPolicy
-QoS::get_history() const
+QoS::history() const
 {
   return static_cast<HistoryPolicy>(rmw_qos_profile_.history);
 }
 
 size_t
-QoS::get_depth() const {return rmw_qos_profile_.depth;}
+QoS::depth() const {return rmw_qos_profile_.depth;}
 
 ReliabilityPolicy
-QoS::get_reliability() const
+QoS::reliability() const
 {
   return static_cast<ReliabilityPolicy>(rmw_qos_profile_.reliability);
 }
 
 DurabilityPolicy
-QoS::get_durability() const
+QoS::durability() const
 {
   return static_cast<DurabilityPolicy>(rmw_qos_profile_.durability);
 }
 
 Duration
-QoS::get_deadline() const {return Duration::from_rmw_time(rmw_qos_profile_.deadline);}
+QoS::deadline() const {return Duration::from_rmw_time(rmw_qos_profile_.deadline);}
 
 Duration
-QoS::get_lifespan() const {return Duration::from_rmw_time(rmw_qos_profile_.lifespan);}
+QoS::lifespan() const {return Duration::from_rmw_time(rmw_qos_profile_.lifespan);}
 
 LivelinessPolicy
-QoS::get_liveliness() const
+QoS::liveliness() const
 {
   return static_cast<LivelinessPolicy>(rmw_qos_profile_.liveliness);
 }
 
 Duration
-QoS::get_liveliness_lease_duration() const
+QoS::liveliness_lease_duration() const
 {
   return Duration::from_rmw_time(rmw_qos_profile_.liveliness_lease_duration);
 }
 
 bool
-QoS::get_avoid_ros_namespace_conventions() const
+QoS::avoid_ros_namespace_conventions() const
 {
   return rmw_qos_profile_.avoid_ros_namespace_conventions;
 }

rclcpp/test/rclcpp/test_qos.cpp

@@ -82,61 +82,61 @@ TEST(TestQoS, setters_and_getters) {
   rclcpp::QoS qos(10);
 
   qos.keep_all();
-  EXPECT_EQ(rclcpp::HistoryPolicy::KeepAll, qos.get_history());
+  EXPECT_EQ(rclcpp::HistoryPolicy::KeepAll, qos.history());
 
   qos.keep_last(20);
-  EXPECT_EQ(rclcpp::HistoryPolicy::KeepLast, qos.get_history());
-  EXPECT_EQ(20u, qos.get_depth());
+  EXPECT_EQ(rclcpp::HistoryPolicy::KeepLast, qos.history());
+  EXPECT_EQ(20u, qos.depth());
 
   qos.reliable();
-  EXPECT_EQ(rclcpp::ReliabilityPolicy::Reliable, qos.get_reliability());
+  EXPECT_EQ(rclcpp::ReliabilityPolicy::Reliable, qos.reliability());
 
   qos.durability_volatile();
-  EXPECT_EQ(rclcpp::DurabilityPolicy::Volatile, qos.get_durability());
+  EXPECT_EQ(rclcpp::DurabilityPolicy::Volatile, qos.durability());
 
   qos.transient_local();
-  EXPECT_EQ(rclcpp::DurabilityPolicy::TransientLocal, qos.get_durability());
+  EXPECT_EQ(rclcpp::DurabilityPolicy::TransientLocal, qos.durability());
 
   qos.history(RMW_QOS_POLICY_HISTORY_KEEP_ALL);
-  EXPECT_EQ(rclcpp::HistoryPolicy::KeepAll, qos.get_history());
+  EXPECT_EQ(rclcpp::HistoryPolicy::KeepAll, qos.history());
 
   qos.history(rclcpp::HistoryPolicy::KeepLast);
-  EXPECT_EQ(rclcpp::HistoryPolicy::KeepLast, qos.get_history());
+  EXPECT_EQ(rclcpp::HistoryPolicy::KeepLast, qos.history());
 
   constexpr rcl_duration_value_t duration_ns = 12345;
   constexpr std::chrono::nanoseconds duration(duration_ns);
   qos.deadline(duration);
-  EXPECT_EQ(duration_ns, qos.get_deadline().nanoseconds());
+  EXPECT_EQ(duration_ns, qos.deadline().nanoseconds());
 
   const rmw_time_t rmw_time {0, 54321};
   qos.deadline(rmw_time);
   EXPECT_EQ(rmw_time.sec, qos.get_rmw_qos_profile().deadline.sec);
   EXPECT_EQ(rmw_time.nsec, qos.get_rmw_qos_profile().deadline.nsec);
 
   qos.lifespan(duration);
-  EXPECT_EQ(duration_ns, qos.get_lifespan().nanoseconds());
+  EXPECT_EQ(duration_ns, qos.lifespan().nanoseconds());
 
   qos.lifespan(rmw_time);
   EXPECT_EQ(rmw_time.sec, qos.get_rmw_qos_profile().lifespan.sec);
   EXPECT_EQ(rmw_time.nsec, qos.get_rmw_qos_profile().lifespan.nsec);
 
   qos.liveliness(RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_TOPIC);
-  EXPECT_EQ(rclcpp::LivelinessPolicy::ManualByTopic, qos.get_liveliness());
+  EXPECT_EQ(rclcpp::LivelinessPolicy::ManualByTopic, qos.liveliness());
 
   qos.liveliness(rclcpp::LivelinessPolicy::Automatic);
-  EXPECT_EQ(rclcpp::LivelinessPolicy::Automatic, qos.get_liveliness());
+  EXPECT_EQ(rclcpp::LivelinessPolicy::Automatic, qos.liveliness());
 
   qos.liveliness_lease_duration(duration);
-  EXPECT_EQ(duration_ns, qos.get_liveliness_lease_duration().nanoseconds());
+  EXPECT_EQ(duration_ns, qos.liveliness_lease_duration().nanoseconds());
 
   qos.liveliness_lease_duration(rmw_time);
   EXPECT_EQ(rmw_time.sec, qos.get_rmw_qos_profile().liveliness_lease_duration.sec);
   EXPECT_EQ(rmw_time.nsec, qos.get_rmw_qos_profile().liveliness_lease_duration.nsec);
 
   qos.avoid_ros_namespace_conventions(true);
-  EXPECT_TRUE(qos.get_avoid_ros_namespace_conventions());
+  EXPECT_TRUE(qos.avoid_ros_namespace_conventions());
   qos.avoid_ros_namespace_conventions(false);
-  EXPECT_FALSE(qos.get_avoid_ros_namespace_conventions());
+  EXPECT_FALSE(qos.avoid_ros_namespace_conventions());
 }
 
 bool operator==(const rmw_qos_profile_t & lhs, const rmw_qos_profile_t & rhs)