refactor(component_interface_utils): prefix package and namespace wit…

…h autoware Signed-off-by: Esteve Fernandez <[email protected]>
autowarefoundation · Oct 30, 2024 · 9939bae · 9939bae
1 parent 94b9ad0
commit 9939bae
Show file tree

Hide file tree

Showing 81 changed files with 217 additions and 206 deletions.
diff --git a/.../component_interface_utils/CMakeLists.txt → ..._component_interface_utils/CMakeLists.txt b/.../component_interface_utils/CMakeLists.txt → ..._component_interface_utils/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.14)
-project(component_interface_utils)
+project(autoware_component_interface_utils)
 
 find_package(autoware_cmake REQUIRED)
 autoware_package()

diff --git a/common/component_interface_utils/README.md → ...oware_component_interface_utils/README.md b/common/component_interface_utils/README.md → ...oware_component_interface_utils/README.md
@@ -1,4 +1,4 @@
-# component_interface_utils
+# autoware_component_interface_utils
 
 ## Features
 
@@ -40,13 +40,13 @@ Create the wrapper using the above definition as follows.
 
 ```cpp
 // header file
-component_interface_utils::Service<SampleService>::SharedPtr srv_;
-component_interface_utils::Client<SampleService>::SharedPtr cli_;
-component_interface_utils::Publisher<SampleMessage>::SharedPtr pub_;
-component_interface_utils::Subscription<SampleMessage>::SharedPtr sub_;
+autoware::component_interface_utils::Service<SampleService>::SharedPtr srv_;
+autoware::component_interface_utils::Client<SampleService>::SharedPtr cli_;
+autoware::component_interface_utils::Publisher<SampleMessage>::SharedPtr pub_;
+autoware::component_interface_utils::Subscription<SampleMessage>::SharedPtr sub_;
 
 // source file
-const auto node = component_interface_utils::NodeAdaptor(this);
+const auto node = autoware::component_interface_utils::NodeAdaptor(this);
 node.init_srv(srv_, callback);
 node.init_cli(cli_);
 node.init_pub(pub_);
@@ -94,7 +94,7 @@ void service_callback(Request req, Response res)
 There are utilities for relaying services and messages of the same type.
 
 ```cpp
-const auto node = component_interface_utils::NodeAdaptor(this);
+const auto node = autoware::component_interface_utils::NodeAdaptor(this);
 service_callback_group_ = create_callback_group(rclcpp::CallbackGroupType::MutuallyExclusive);
 node.relay_message(pub_, sub_);
 node.relay_service(cli_, srv_, service_callback_group_);  // group is for avoiding deadlocks

diff --git a/...lude/component_interface_utils/rclcpp.hpp → ...ware/component_interface_utils/rclcpp.hpp b/...lude/component_interface_utils/rclcpp.hpp → ...ware/component_interface_utils/rclcpp.hpp
@@ -12,21 +12,21 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
 
-#include <component_interface_utils/rclcpp/create_interface.hpp>
-#include <component_interface_utils/rclcpp/interface.hpp>
-#include <component_interface_utils/rclcpp/service_client.hpp>
-#include <component_interface_utils/rclcpp/service_server.hpp>
-#include <component_interface_utils/rclcpp/topic_publisher.hpp>
-#include <component_interface_utils/rclcpp/topic_subscription.hpp>
+#include <autoware/component_interface_utils/rclcpp/create_interface.hpp>
+#include <autoware/component_interface_utils/rclcpp/interface.hpp>
+#include <autoware/component_interface_utils/rclcpp/service_client.hpp>
+#include <autoware/component_interface_utils/rclcpp/service_server.hpp>
+#include <autoware/component_interface_utils/rclcpp/topic_publisher.hpp>
+#include <autoware/component_interface_utils/rclcpp/topic_subscription.hpp>
 
 #include <memory>
 #include <optional>
 #include <utility>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 class NodeAdaptor
@@ -123,6 +123,6 @@ class NodeAdaptor
   NodeInterface::SharedPtr interface_;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP_HPP_
diff --git a/...terface_utils/rclcpp/create_interface.hpp → ...terface_utils/rclcpp/create_interface.hpp b/...terface_utils/rclcpp/create_interface.hpp → ...terface_utils/rclcpp/create_interface.hpp
@@ -12,20 +12,20 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
 
-#include <component_interface_utils/rclcpp/interface.hpp>
-#include <component_interface_utils/rclcpp/service_client.hpp>
-#include <component_interface_utils/rclcpp/service_server.hpp>
-#include <component_interface_utils/rclcpp/topic_publisher.hpp>
-#include <component_interface_utils/rclcpp/topic_subscription.hpp>
-#include <component_interface_utils/specs.hpp>
+#include <autoware/component_interface_utils/rclcpp/interface.hpp>
+#include <autoware/component_interface_utils/rclcpp/service_client.hpp>
+#include <autoware/component_interface_utils/rclcpp/service_server.hpp>
+#include <autoware/component_interface_utils/rclcpp/topic_publisher.hpp>
+#include <autoware/component_interface_utils/rclcpp/topic_subscription.hpp>
+#include <autoware/component_interface_utils/specs.hpp>
 #include <rclcpp/rclcpp.hpp>
 
 #include <utility>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 /// Create a client wrapper for logging. This is a private implementation.
@@ -72,6 +72,6 @@ typename Subscription<SpecT>::SharedPtr create_subscription_impl(
   return Subscription<SpecT>::make_shared(subscription);
 }
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__CREATE_INTERFACE_HPP_
diff --git a/...ent_interface_utils/rclcpp/exceptions.hpp → ...ent_interface_utils/rclcpp/exceptions.hpp b/...ent_interface_utils/rclcpp/exceptions.hpp → ...ent_interface_utils/rclcpp/exceptions.hpp
@@ -12,15 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
 
 #include <autoware_adapi_v1_msgs/msg/response_status.hpp>
 
 #include <exception>
 #include <string>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 class ServiceException : public std::exception
@@ -104,6 +104,6 @@ class NoEffectWarning : public ServiceException
   }
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__EXCEPTIONS_HPP_
diff --git a/...nent_interface_utils/rclcpp/interface.hpp → ...nent_interface_utils/rclcpp/interface.hpp b/...nent_interface_utils/rclcpp/interface.hpp → ...nent_interface_utils/rclcpp/interface.hpp
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
 
 #include <rclcpp/rclcpp.hpp>
 
@@ -23,7 +23,7 @@
 #include <string>
 #include <unordered_map>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 struct NodeInterface
@@ -68,6 +68,6 @@ struct NodeInterface
   std::string node_name;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__INTERFACE_HPP_
diff --git a/...interface_utils/rclcpp/service_client.hpp → ...interface_utils/rclcpp/service_client.hpp b/...interface_utils/rclcpp/service_client.hpp → ...interface_utils/rclcpp/service_client.hpp
@@ -12,11 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
 
-#include <component_interface_utils/rclcpp/exceptions.hpp>
-#include <component_interface_utils/rclcpp/interface.hpp>
+#include <autoware/component_interface_utils/rclcpp/exceptions.hpp>
+#include <autoware/component_interface_utils/rclcpp/interface.hpp>
 #include <rclcpp/node.hpp>
 
 #include <tier4_system_msgs/msg/service_log.hpp>
@@ -25,7 +25,7 @@
 #include <string>
 #include <utility>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 /// The wrapper class of rclcpp::Client for logging.
@@ -104,6 +104,6 @@ class Client
   NodeInterface::SharedPtr interface_;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_CLIENT_HPP_
diff --git a/...interface_utils/rclcpp/service_server.hpp → ...interface_utils/rclcpp/service_server.hpp b/...interface_utils/rclcpp/service_server.hpp → ...interface_utils/rclcpp/service_server.hpp
@@ -12,18 +12,18 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
 
-#include <component_interface_utils/rclcpp/exceptions.hpp>
-#include <component_interface_utils/rclcpp/interface.hpp>
+#include <autoware/component_interface_utils/rclcpp/exceptions.hpp>
+#include <autoware/component_interface_utils/rclcpp/interface.hpp>
 #include <rclcpp/node.hpp>
 
 #include <tier4_system_msgs/msg/service_log.hpp>
 
 #include <string>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 /// The wrapper class of rclcpp::Service for logging.
@@ -94,6 +94,6 @@ class Service
   NodeInterface::SharedPtr interface_;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__SERVICE_SERVER_HPP_
diff --git a/...nterface_utils/rclcpp/topic_publisher.hpp → ...nterface_utils/rclcpp/topic_publisher.hpp b/...nterface_utils/rclcpp/topic_publisher.hpp → ...nterface_utils/rclcpp/topic_publisher.hpp
@@ -12,12 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
 
 #include <rclcpp/publisher.hpp>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 /// The wrapper class of rclcpp::Publisher. This is for future use and no functionality now.
@@ -43,6 +43,6 @@ class Publisher
   typename WrapType::SharedPtr publisher_;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_PUBLISHER_HPP_
diff --git a/...rface_utils/rclcpp/topic_subscription.hpp → ...rface_utils/rclcpp/topic_subscription.hpp b/...rface_utils/rclcpp/topic_subscription.hpp → ...rface_utils/rclcpp/topic_subscription.hpp
@@ -12,12 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
-#define COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
 
 #include <rclcpp/subscription.hpp>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 /// The wrapper class of rclcpp::Subscription. This is for future use and no functionality now.
@@ -40,6 +40,6 @@ class Subscription
   typename WrapType::SharedPtr subscription_;
 };
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__RCLCPP__TOPIC_SUBSCRIPTION_HPP_
diff --git a/...clude/component_interface_utils/specs.hpp → ...oware/component_interface_utils/specs.hpp b/...clude/component_interface_utils/specs.hpp → ...oware/component_interface_utils/specs.hpp
@@ -12,12 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__SPECS_HPP_
-#define COMPONENT_INTERFACE_UTILS__SPECS_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__SPECS_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__SPECS_HPP_
 
 #include <rclcpp/qos.hpp>
 
-namespace component_interface_utils
+namespace autoware::component_interface_utils
 {
 
 template <class SpecT>
@@ -29,6 +29,6 @@ rclcpp::QoS get_qos()
   return qos;
 }
 
-}  // namespace component_interface_utils
+}  // namespace autoware::component_interface_utils
 
-#endif  // COMPONENT_INTERFACE_UTILS__SPECS_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__SPECS_HPP_
diff --git a/...lude/component_interface_utils/status.hpp → ...ware/component_interface_utils/status.hpp b/...lude/component_interface_utils/status.hpp → ...ware/component_interface_utils/status.hpp
@@ -12,10 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef COMPONENT_INTERFACE_UTILS__STATUS_HPP_
-#define COMPONENT_INTERFACE_UTILS__STATUS_HPP_
+#ifndef AUTOWARE__COMPONENT_INTERFACE_UTILS__STATUS_HPP_
+#define AUTOWARE__COMPONENT_INTERFACE_UTILS__STATUS_HPP_
 
-namespace component_interface_utils::status
+namespace autoware::component_interface_utils::status
 {
 
 template <class T1, class T2>
@@ -26,6 +26,6 @@ void copy(const T1 & src, T2 & dst)  // NOLINT(build/include_what_you_use): cppl
   dst->status.message = src->status.message;
 }
 
-}  // namespace component_interface_utils::status
+}  // namespace autoware::component_interface_utils::status
 
-#endif  // COMPONENT_INTERFACE_UTILS__STATUS_HPP_
+#endif  // AUTOWARE__COMPONENT_INTERFACE_UTILS__STATUS_HPP_
diff --git a/common/component_interface_utils/package.xml → ...are_component_interface_utils/package.xml b/common/component_interface_utils/package.xml → ...are_component_interface_utils/package.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0"?>
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
-  <name>component_interface_utils</name>
+  <name>autoware_component_interface_utils</name>
   <version>0.0.0</version>
-  <description>The component_interface_utils package</description>
+  <description>The autoware_component_interface_utils package</description>
   <maintainer email="[email protected]">Takagi, Isamu</maintainer>
   <maintainer email="[email protected]">Yukihiro Saito</maintainer>
   <license>Apache License 2.0</license>

diff --git a/...s/test/test_component_interface_utils.cpp → ...s/test/test_component_interface_utils.cpp b/...s/test/test_component_interface_utils.cpp → ...s/test/test_component_interface_utils.cpp
@@ -12,15 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "component_interface_utils/rclcpp/exceptions.hpp"
-#include "component_interface_utils/specs.hpp"
-#include "component_interface_utils/status.hpp"
+#include "autoware/component_interface_utils/rclcpp/exceptions.hpp"
+#include "autoware/component_interface_utils/specs.hpp"
+#include "autoware/component_interface_utils/status.hpp"
 #include "gtest/gtest.h"
 
 TEST(interface, utils)
 {
   {
-    using component_interface_utils::ServiceException;
+    using autoware::component_interface_utils::ServiceException;
     using ResponseStatus = autoware_adapi_v1_msgs::msg::ResponseStatus;
     using ResponseStatusCode = ResponseStatus::_code_type;
 
@@ -34,7 +34,7 @@ TEST(interface, utils)
   }
 
   {
-    using component_interface_utils::ServiceException;
+    using autoware::component_interface_utils::ServiceException;
     using ResponseStatus = autoware_adapi_v1_msgs::msg::ResponseStatus;
     using ResponseStatusCode = ResponseStatus::_code_type;
 
@@ -48,10 +48,10 @@ TEST(interface, utils)
   }
 
   {
-    using component_interface_utils::ServiceException;
+    using autoware::component_interface_utils::ServiceException;
     using ResponseStatus = autoware_adapi_v1_msgs::msg::ResponseStatus;
     using ResponseStatusCode = ResponseStatus::_code_type;
-    using component_interface_utils::status::copy;
+    using autoware::component_interface_utils::status::copy;
 
     class status_test
     {