Another name change; using Handler instead of the more passive term, Monitor

Michael Jeronimo · Michael Jeronimo · commit 894da98dbaaf · 2021-01-08T12:34:10.000-08:00
Signed-off-by: Michael Jeronimo &lt;michael.jeronimo@openrobotics.org&gt;
diff --git a/rclcpp/CMakeLists.txt b/rclcpp/CMakeLists.txt
@@ -79,7 +79,7 @@ set(${PROJECT_NAME}_SRCS
   src/rclcpp/parameter.cpp
   src/rclcpp/parameter_value.cpp
   src/rclcpp/parameter_client.cpp
-  src/rclcpp/parameter_event_monitor.cpp
+  src/rclcpp/parameter_event_handler.cpp
   src/rclcpp/parameter_events_filter.cpp
   src/rclcpp/parameter_map.cpp
   src/rclcpp/parameter_service.cpp
diff --git a/rclcpp/include/rclcpp/parameter_event_handler.hpp b/rclcpp/include/rclcpp/parameter_event_handler.hpp
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLCPP__PARAMETER_EVENT_MONITOR_HPP_
-#define RCLCPP__PARAMETER_EVENT_MONITOR_HPP_
+#ifndef RCLCPP__PARAMETER_EVENT_HANDLER_HPP_
+#define RCLCPP__PARAMETER_EVENT_HANDLER_HPP_
 
 #include <list>
 #include <memory>
@@ -58,7 +58,7 @@ struct ParameterEventCallbackHandle
   ParameterEventCallbackType callback;
 };
 
-class ParameterEventMonitor
+class ParameterEventHandler
 {
 public:
   /// Construct a parameter events monitor.
@@ -67,7 +67,7 @@ class ParameterEventMonitor
    * \param[in] qos The QoS settings to use for any subscriptions.
    */
   template<typename NodeT>
-  ParameterEventMonitor(
+  ParameterEventHandler(
     NodeT node,
     const rclcpp::QoS & qos =
     rclcpp::QoS(rclcpp::QoSInitialization::from_rmw(rmw_qos_profile_parameter_events)))
@@ -78,7 +78,7 @@ class ParameterEventMonitor
 
     event_subscription_ = rclcpp::create_subscription<rcl_interfaces::msg::ParameterEvent>(
       node_topics, "/parameter_events", qos,
-      std::bind(&ParameterEventMonitor::event_callback, this, std::placeholders::_1));
+      std::bind(&ParameterEventHandler::event_callback, this, std::placeholders::_1));
   }
 
   using ParameterEventCallbackType =
@@ -238,4 +238,4 @@ class ParameterEventMonitor
 
 }  // namespace rclcpp
 
-#endif  // RCLCPP__PARAMETER_EVENT_MONITOR_HPP_
+#endif  // RCLCPP__PARAMETER_EVENT_HANDLER_HPP_
diff --git a/rclcpp/include/rclcpp/rclcpp.hpp b/rclcpp/include/rclcpp/rclcpp.hpp
@@ -148,7 +148,7 @@
 #include "rclcpp/logging.hpp"
 #include "rclcpp/node.hpp"
 #include "rclcpp/parameter_client.hpp"
-#include "rclcpp/parameter_event_monitor.hpp"
+#include "rclcpp/parameter_event_handler.hpp"
 #include "rclcpp/parameter.hpp"
 #include "rclcpp/parameter_service.hpp"
 #include "rclcpp/rate.hpp"
diff --git a/rclcpp/src/rclcpp/parameter_event_handler.cpp b/rclcpp/src/rclcpp/parameter_event_handler.cpp
@@ -19,14 +19,14 @@
 #include <utility>
 #include <vector>
 
-#include "rclcpp/parameter_event_monitor.hpp"
+#include "rclcpp/parameter_event_handler.hpp"
 #include "rcpputils/join.hpp"
 
 namespace rclcpp
 {
 
 ParameterEventCallbackHandle::SharedPtr
-ParameterEventMonitor::add_parameter_event_callback(
+ParameterEventHandler::add_parameter_event_callback(
   ParameterEventCallbackType callback)
 {
   std::lock_guard<std::recursive_mutex> lock(mutex_);
@@ -55,7 +55,7 @@ struct HandleCompare
 };
 
 void
-ParameterEventMonitor::remove_parameter_event_callback(
+ParameterEventHandler::remove_parameter_event_callback(
   const ParameterEventCallbackHandle * const handle)
 {
   std::lock_guard<std::recursive_mutex> lock(mutex_);
@@ -71,7 +71,7 @@ ParameterEventMonitor::remove_parameter_event_callback(
 }
 
 ParameterCallbackHandle::SharedPtr
-ParameterEventMonitor::add_parameter_callback(
+ParameterEventHandler::add_parameter_callback(
   const std::string & parameter_name,
   ParameterCallbackType callback,
   const std::string & node_name)
@@ -90,7 +90,7 @@ ParameterEventMonitor::add_parameter_callback(
 }
 
 void
-ParameterEventMonitor::remove_parameter_callback(
+ParameterEventHandler::remove_parameter_callback(
   const ParameterCallbackHandle * const handle)
 {
   std::lock_guard<std::recursive_mutex> lock(mutex_);
@@ -110,7 +110,7 @@ ParameterEventMonitor::remove_parameter_callback(
 }
 
 bool
-ParameterEventMonitor::get_parameter_from_event(
+ParameterEventHandler::get_parameter_from_event(
   const rcl_interfaces::msg::ParameterEvent & event,
   rclcpp::Parameter & parameter,
   const std::string parameter_name,
@@ -138,7 +138,7 @@ ParameterEventMonitor::get_parameter_from_event(
 }
 
 rclcpp::Parameter
-ParameterEventMonitor::get_parameter_from_event(
+ParameterEventHandler::get_parameter_from_event(
   const rcl_interfaces::msg::ParameterEvent & event,
   const std::string parameter_name,
   const std::string node_name)
@@ -153,7 +153,7 @@ ParameterEventMonitor::get_parameter_from_event(
 }
 
 std::vector<rclcpp::Parameter>
-ParameterEventMonitor::get_parameters_from_event(
+ParameterEventHandler::get_parameters_from_event(
   const rcl_interfaces::msg::ParameterEvent & event)
 {
   std::vector<rclcpp::Parameter> params;
@@ -170,7 +170,7 @@ ParameterEventMonitor::get_parameters_from_event(
 }
 
 void
-ParameterEventMonitor::event_callback(
+ParameterEventHandler::event_callback(
   const rcl_interfaces::msg::ParameterEvent::SharedPtr event)
 {
   std::lock_guard<std::recursive_mutex> lock(mutex_);
@@ -200,7 +200,7 @@ ParameterEventMonitor::event_callback(
 }
 
 std::string
-ParameterEventMonitor::resolve_path(const std::string & path)
+ParameterEventHandler::resolve_path(const std::string & path)
 {
   std::string full_path;
 
diff --git a/rclcpp/test/rclcpp/CMakeLists.txt b/rclcpp/test/rclcpp/CMakeLists.txt
@@ -323,15 +323,15 @@ if(TARGET test_parameter)
   )
   target_link_libraries(test_parameter ${PROJECT_NAME})
 endif()
-ament_add_gtest(test_parameter_event_monitor test_parameter_event_monitor.cpp)
-if(TARGET test_parameter_event_monitor)
-  ament_target_dependencies(test_parameter_event_monitor
+ament_add_gtest(test_parameter_event_handler test_parameter_event_handler.cpp)
+if(TARGET test_parameter_event_handler)
+  ament_target_dependencies(test_parameter_event_handler
     "rcl_interfaces"
     "rmw"
     "rosidl_generator_cpp"
     "rosidl_typesupport_cpp"
   )
-  target_link_libraries(test_parameter_event_monitor ${PROJECT_NAME})
+  target_link_libraries(test_parameter_event_handler ${PROJECT_NAME})
 endif()
 ament_add_gtest(test_parameter_map test_parameter_map.cpp)
 if(TARGET test_parameter_map)
diff --git a/rclcpp/test/rclcpp/test_parameter_event_handler.cpp b/rclcpp/test/rclcpp/test_parameter_event_handler.cpp

Original file line number	Diff line number	Diff line change
`@@ -19,14 +19,14 @@`
`19`	`19`	`#include <utility>`
`20`	`20`	`#include <vector>`
`21`	`21`
`22`		`-#include "rclcpp/parameter_event_monitor.hpp"`
	`22`	`+#include "rclcpp/parameter_event_handler.hpp"`
`23`	`23`	`#include "rcpputils/join.hpp"`
`24`	`24`
`25`	`25`	`namespace rclcpp`
`26`	`26`	`{`
`27`	`27`
`28`	`28`	`ParameterEventCallbackHandle::SharedPtr`
`29`		`-ParameterEventMonitor::add_parameter_event_callback(`
	`29`	`+ParameterEventHandler::add_parameter_event_callback(`
`30`	`30`	`ParameterEventCallbackType callback)`
`31`	`31`	`{`
`32`	`32`	`std::lock_guard<std::recursive_mutex> lock(mutex_);`
`@@ -55,7 +55,7 @@ struct HandleCompare`
`55`	`55`	`};`
`56`	`56`
`57`	`57`	`void`
`58`		`-ParameterEventMonitor::remove_parameter_event_callback(`
	`58`	`+ParameterEventHandler::remove_parameter_event_callback(`
`59`	`59`	`const ParameterEventCallbackHandle * const handle)`
`60`	`60`	`{`
`61`	`61`	`std::lock_guard<std::recursive_mutex> lock(mutex_);`
`@@ -71,7 +71,7 @@ ParameterEventMonitor::remove_parameter_event_callback(`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`ParameterCallbackHandle::SharedPtr`
`74`		`-ParameterEventMonitor::add_parameter_callback(`
	`74`	`+ParameterEventHandler::add_parameter_callback(`
`75`	`75`	`const std::string & parameter_name,`
`76`	`76`	`ParameterCallbackType callback,`
`77`	`77`	`const std::string & node_name)`
`@@ -90,7 +90,7 @@ ParameterEventMonitor::add_parameter_callback(`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`void`
`93`		`-ParameterEventMonitor::remove_parameter_callback(`
	`93`	`+ParameterEventHandler::remove_parameter_callback(`
`94`	`94`	`const ParameterCallbackHandle * const handle)`
`95`	`95`	`{`
`96`	`96`	`std::lock_guard<std::recursive_mutex> lock(mutex_);`
`@@ -110,7 +110,7 @@ ParameterEventMonitor::remove_parameter_callback(`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`bool`
`113`		`-ParameterEventMonitor::get_parameter_from_event(`
	`113`	`+ParameterEventHandler::get_parameter_from_event(`
`114`	`114`	`const rcl_interfaces::msg::ParameterEvent & event,`
`115`	`115`	`rclcpp::Parameter & parameter,`
`116`	`116`	`const std::string parameter_name,`
`@@ -138,7 +138,7 @@ ParameterEventMonitor::get_parameter_from_event(`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`rclcpp::Parameter`
`141`		`-ParameterEventMonitor::get_parameter_from_event(`
	`141`	`+ParameterEventHandler::get_parameter_from_event(`
`142`	`142`	`const rcl_interfaces::msg::ParameterEvent & event,`
`143`	`143`	`const std::string parameter_name,`
`144`	`144`	`const std::string node_name)`
`@@ -153,7 +153,7 @@ ParameterEventMonitor::get_parameter_from_event(`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`std::vector<rclcpp::Parameter>`
`156`		`-ParameterEventMonitor::get_parameters_from_event(`
	`156`	`+ParameterEventHandler::get_parameters_from_event(`
`157`	`157`	`const rcl_interfaces::msg::ParameterEvent & event)`
`158`	`158`	`{`
`159`	`159`	`std::vector<rclcpp::Parameter> params;`
`@@ -170,7 +170,7 @@ ParameterEventMonitor::get_parameters_from_event(`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`void`
`173`		`-ParameterEventMonitor::event_callback(`
	`173`	`+ParameterEventHandler::event_callback(`
`174`	`174`	`const rcl_interfaces::msg::ParameterEvent::SharedPtr event)`
`175`	`175`	`{`
`176`	`176`	`std::lock_guard<std::recursive_mutex> lock(mutex_);`
`@@ -200,7 +200,7 @@ ParameterEventMonitor::event_callback(`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`std::string`
`203`		`-ParameterEventMonitor::resolve_path(const std::string & path)`
	`203`	`+ParameterEventHandler::resolve_path(const std::string & path)`
`204`	`204`	`{`
`205`	`205`	`std::string full_path;`
`206`	`206`