From 90e779171ee7803ae3d087adf69beb5f9e0ff2ee Mon Sep 17 00:00:00 2001 From: Ryohsuke Mitsudome Date: Wed, 15 Jan 2025 15:10:04 +0900 Subject: [PATCH] docs: update README Signed-off-by: Ryohsuke Mitsudome --- common/autoware_component_interface_specs/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/common/autoware_component_interface_specs/README.md b/common/autoware_component_interface_specs/README.md index c3cf0ee1c0..9c4f057762 100644 --- a/common/autoware_component_interface_specs/README.md +++ b/common/autoware_component_interface_specs/README.md @@ -24,25 +24,23 @@ The package contains interface specifications for various components, including: To use these interface specifications in your component: 1. Add this package as a dependency in your package.xml: - ```xml autoware_component_interface_specs ``` - 2. Use the provided interfaces in your component code. - ```cpp #include // Example: Creating a publisher using the interface specs +using KinematicState = autoware::component_interface_specs::localization::KinematicState; rclcpp::Publisher::SharedPtr publisher_ = create_publisher( KinematicState::name, -KinematicState::get_qos()); +autoware::component_interface_specs::get_qos(KinematicState)); // Example: Creating a subscription using the interface specs auto subscriber_ = create_subscription( KinematicState::name, -KinematicState::get_qos(), +autoware::component_interface_specs::get_qos(KinematicState), std::bind(&YourClass::callback, this, std::placeholders::1)); ```