本文主要是介绍ROS 2边学边练(20)-- 创建和使用插件(C++),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
作为入门篇的最后一章,我们来了解下ROS 2中插件的相关内容(使用过Qt插件的同学应该有点体会,话说Qt插件的创建也是比较让人头疼的,为什么不搞的更友好点呢)。
前言
ROS中使用pluginlib(一个C++库)来实现插件功能,应用程序在运行时通过加载的方式调用插件里面的功能,未来也不用修改应用程序的源代码来改变功能,也不须提取声明包含插件的有关头文件之类,也不须显示的链接到库,只需修改插件即可。打个不恰当的比方,PC是我们的应用程序,U盘是一个插件,当将U盘插到电脑上的插口时,PC读取该U盘的内容,然后利用这些内容数据去执行其他的处理流程,无U盘插入,我们也不用管它。
动动手
创建基类功能包
我们在ros2_ws/src路径下创建一个空的功能包,作为一个基类(面向对象编程中的一种类,里面会有些纯虚函数,新的类会继承这个基类然后按需要去实现这些纯虚函数):
$ros2 pkg create --build-type ament_cmake --license Apache-2.0 --dependencies pluginlib --node-name area_node polygon_base
然后打开ros2_ws/src/polygon_base/include/polygon_base/regular_polygon.hpp,将下面内容复制进去:
#ifndef POLYGON_BASE_REGULAR_POLYGON_HPP
#define POLYGON_BASE_REGULAR_POLYGON_HPPnamespace polygon_base
{class RegularPolygon{public:virtual void initialize(double side_length) = 0;virtual double area() = 0;virtual ~RegularPolygon(){}protected:RegularPolygon(){}};
} // namespace polygon_base#endif // POLYGON_BASE_REGULAR_POLYGON_HPP
上面的代码创建了一个叫RegularPolygon的抽象类,我们需要注意它的初始化方法(void initialize(double side_length)),在使用了pluginlib后,类的构造函数是不允许传参的,如果这个类的确需要这些参数,那我们就可以通过它的初始化函数将这些参数传给对象。
其他类如果要能找到并使用这个头文件,我们得修改下ros2_ws/src/polygon_base/CMakeLists.txt,将下面的内容复制到ament_target_dependencies这行的后面:
install(DIRECTORY include/DESTINATION include
)
并将下面的内容复制到ament_package的前面:
ament_export_include_directories(include
)
我们会在后面往这个包创建我们的测试节点。
创建插件功能包
我们打开另外一个终端,进入ros2_ws/src路径,通过下面命令创建插件包polygon_plugins:
$ros2 pkg create --build-type ament_cmake --license Apache-2.0 --dependencies polygon_base pluginlib --library-name polygon_plugins polygon_plugins
我们将会实现那个抽象类里面的两个纯虚函数。
编写插件源代码
将下面内容复制到ros2_ws/src/polygon_plugins/src/polygon_plugins.cpp(此文件需要新建):
#include <polygon_base/regular_polygon.hpp>
#include <cmath>namespace polygon_plugins
{class Square : public polygon_base::RegularPolygon{public:void initialize(double side_length) override{side_length_ = side_length;}double area() override{return side_length_ * side_length_;}protected:double side_length_;};class Triangle : public polygon_base::RegularPolygon{public:void initialize(double side_length) override{side_length_ = side_length;}double area() override{return 0.5 * side_length_ * getHeight();}double getHeight(){return sqrt((side_length_ * side_length_) - ((side_length_ / 2) * (side_length_ / 2)));}protected:double side_length_;};
}#include <pluginlib/class_list_macros.hpp>PLUGINLIB_EXPORT_CLASS(polygon_plugins::Square, polygon_base::RegularPolygon)
PLUGINLIB_EXPORT_CLASS(polygon_plugins::Triangle, polygon_base::RegularPolygon)
我们在命名空间polygon_plugins内定义了两个继承类Square和Triangle,并实现了那个抽象类(命名空间polygon_base下的基类RegularPolygon)里面的纯虚函数void initialize(double side_length)和double area(),除此之外,它们还各自定义实现了它们自己的其他函数。在最后包含了类宏的头文件(因为紧接着下面即使用了相关的宏),这个宏PLUGINLIB_EXPORT_CLASS的作用是注册我们实现的这两个类(Square和Triangle)作为真正的插件。
XML文件声明插件
上面的步骤允许在加载包含库时创建插件实例,但插件加载程序仍然需要找到该库并知道在该库中引用什么。为此,我们还将创建一个XML文件,该文件与包清单中的一个特殊导出行一起,使ROS工具链可以获得有关插件的所有必要信息。
在ros2_ws/src/polygon_plugins/路径下创建plugins.xml,将下面内容复制到里面:
<library path="polygon_plugins"><class type="polygon_plugins::Square" base_class_type="polygon_base::RegularPolygon"><description>This is a square plugin.</description></class><class type="polygon_plugins::Triangle" base_class_type="polygon_base::RegularPolygon"><description>This is a triangle plugin.</description></class>
</library>
有两点说明:
1. library标记提供了一个库的相对路径,该库包含我们要导出的插件。在ROS 2中,这只是库的名称。在ROS 1中,它包含前缀lib,有时包含lib/lib(即lib/libpolygon_plugins),但这里更简单;
2. class标记声明了一个我们想要从库中导出的插件。我们来看看它的参数:
type:插件的完全限定类型。对我们来说,这个类型就是polygon_plugins::Square;
base_class:插件的完全限定基类类型。对我们来说,这个类型就是polygon_base::RegularPolygon;
description:插件及其功能的描述。
CMake插件声明
最后一步是通过CMakeLists.txt导出插件。这与ROS 1有所不同,ROS 1通过package.xml进行导出。将以下行添加到ros2_ws/src/polgon_plugins/CMakeLists.txt 的find_package(pluginlib REQUIRED)行之后:
pluginlib_export_plugin_description_file(polygon_base plugins.xml)
其中的两个参数所代表的意思是:
1. 该包的基类,polygon_base;
2. 插件声明文件(xml)的相对路径,plugins.xml.
使用插件
下面我们可以看看怎么来使用这个插件,理论上我们可以在任何其他的功能包中使用它,但是我们准备在基类包中用用,我们先将下列内容复制到ros2_ws/src/polygon_base/src/area_node.cpp中:
#include <pluginlib/class_loader.hpp>
#include <polygon_base/regular_polygon.hpp>int main(int argc, char** argv)
{// To avoid unused parameter warnings(void) argc;(void) argv;pluginlib::ClassLoader<polygon_base::RegularPolygon> poly_loader("polygon_base", "polygon_base::RegularPolygon");try{std::shared_ptr<polygon_base::RegularPolygon> triangle = poly_loader.createSharedInstance("polygon_plugins::Triangle");triangle->initialize(10.0);std::shared_ptr<polygon_base::RegularPolygon> square = poly_loader.createSharedInstance("polygon_plugins::Square");square->initialize(10.0);printf("Triangle area: %.2f\n", triangle->area());printf("Square area: %.2f\n", square->area());}catch(pluginlib::PluginlibException& ex){printf("The plugin failed to load for some reason. Error: %s\n", ex.what());}return 0;
}
上面的代码中,ClassLoader是关键的一个类,它就是那个加载插件的程序,在class_loader.hpp头文件中定义:
- 它是用基类模板化的,即polygon_base::RegularPolygon;
- 第一个参数是基类的包名称的字符串,即polygon_base;
- 第二个参数是具有插件的完全限定基类类型的字符串,即polygon_base::RegularPolygon。
有许多方法可以实例化类的实例。在这个例子中,我们使用共享指针。我们只需要使用插件类的完全限定类型调用createSharedInstance,在本例中为polygon_plugins::Square。
重要提示:定义此节点的polygon_base包不依赖于polygon_plugins类。插件将动态加载,无需声明任何依赖项。此外,我们正在用硬编码的插件名称实例化类,但我们也可以使用参数等动态地进行实例化。
构建运行
我们回到工作空间根路径,执行下面的命令去构建我们今天创建的两个功能包:
$colcon build --packages-select polygon_base polygon_plugins
现在来试着启动下area_node这个节点:
$ros2 run polygon_base area_node
看现象,的确是调用成功了。
如果感觉这个插件的创建和使用还是有点不方便,说明还是不熟,等熟悉了之后再来过一遍今天的内容,应该还是比较easy的。
本篇完。
这篇关于ROS 2边学边练(20)-- 创建和使用插件(C++)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!