【转载】ROS 中 CMakeLists.txt 文件使用的讲解与总结

本博客转载自【阿里云开发者社区】ROS 中 CMakeLists.txt 文件使用讲解与总结一、CMakeLists.txt 作用在ROS系统的功能包中要包含 CMakeLists.txt 与 package.xml 文件来编译功能包的内容。CMakeLists.txt 原本是 Cmake 编译系统的规则文件而Catkin 编译系统基本沿用了 CMake 的编译风格只是针对 ROS 工程添加了一些宏定义。所以在写法上catkin 的 CMakeLists.txt 与 CMake 的基本一致。catkin 的 CMakeLists.txt 文件直接规定了这个 package 要依赖哪些 package要编译生成哪些目标如何编译等等流程。所以 ROS 中 CMakeLists.txt 非常重要它指定了由源码到目标文件的规则catkin 编译系统在工作时首先会找到每个 package 下的 CMakeLists.txt 然后按照规则来编译构建。二、CMakeLists.txt 写法CMakeLists.txt 的基本语法都还是按照 CMake而 Catkin 在其中加入了少量的宏。指令/方法作用/说明cmake_minimum_required()CMake 的版本号project()项目名称find_package()找到编译需要的其他 CMake/Catkin packagecatkin_python_setup()catkin 新加宏打开 catkin 的 Python Module 的支持add_message_files()catkin 新加宏添加自定义 Message 文件generate_message()catkin 新加宏生成不同语言版本的 msg/srv/action 接口add_service_files()catkin 新加宏添加自定义 Service 文件add_action_files()catkin 新加宏添加自定义 Action 文件catkin_package()catkin 新加宏生成当前 package 的 cmake 配置供依赖本包的其他软件包调用catkin_add_gtest()catkin 新加宏生成测试add_library()生成库add_executable()生成可执行二进制文件add_dependencies()定义目标文件依赖于其他目标文件确保其他目标已被构建target_link_libraries()链接install()安装至本机三、CMakeLists.txt 实例为了详细的解释 CMakeLists.txt 的写法以 turtlesim 小海龟这个 pacakge 为例进行讲解。可 roscd 到 tuetlesim 包下查看在 turtlesim/CMakeLists.txt 的写法如下:cmake_minimum_required(VERSION 2.8.3) # CMake至少为2.8.3版 project(turtlesim) # 项目 (package) 名称为 turtlesim在后续文件中可使用变量 ${PROJECT_NAME} 来引用项目名称 turltesim # 这两个是 通过ros 指令 创建包 中就自动生成好的 find_package(catkin REQUIRED COMPONENTS geometry_msgs message_generation rosconsole roscpp roscpp_serialization roslib rostime std_msgs std_srvs) # cmake 宏指定依赖的其他 pacakge实际是生成了一些环境变量如 NAME_FOUND, NAME_INCLUDE_DIRS , NAME_LIBRARYIS # 此处catkin是必备依赖 其余的 geometry_msgs... 为组件 include_directories(include ${catkin_INCLUDE_DIRS} ${Boost_INCLUDE_DIRS}) # 指定C的头文件路径 link_directories(${catkin_LIBRARY_DIRS}) # 指定链接库的路径 add_message_files(DIRECTORY msg FILES Color.msg Pose.msg) #自定义msg文件 add_service_files(DIRECTORY srv FILES Kill.srv SetPen.srv Spawn.srv TeleportAbsolute.srv TeleportRelative.srv) #自定义srv文件 generate_messages(DEPENDENCIES geometry_msgs std_msgs std_srvs) # 在 add_message_files、add_service_files 宏之后必须加上这句话用于生成 srv msg 头文件生 成的文件位于 devel/include 中 catkin_package(CATKIN_DEPENDS geometry_msgs message_runtime std_msgs std_srvs) # catkin 宏命令用于配置 ROS 的 package 配置文件和 CMake 文件 # 这个命令必须在 add_library() 或者 add_executable() 之前调用该函数有 5 个可选参数 # (1) INCLUDE_DIRS - 导出包的include路径 # (2) LIBRARIES - 导出项目中的库 # (3) CATKIN_DEPENDS - 该项目依赖的其他catkin项目 # (4) DEPENDS - 该项目所依赖的非catkin CMake项目。 # (5) CFG_EXTRAS - 其他配置选 set(turtlesim_node_SRCS src/turtlesim.cpp src/turtle.cpp src/turtle_frame.cpp) set(turtlesim_node_HDRS include/turtlesim/turtle_frame.h ) # 指定 turtlesim_node_SRCS、turtlesim_node_HDRS 变量 qt5_wrap_cpp(turtlesim_node_MOCS ${turtlesim_node_HDRS}) add_executable(turtlesim_node ${turtlesim_node_SRCS} ${turtlesim_node_MOCS}) # 指定可执行文件目标turtlesim_node target_link_libraries(turtlesim_node Qt5::Widgets ${catkin_LIBRARIES} ${Boost_LIBRARIE S}) # 指定链接可执行文件 add_dependencies(turtlesim_node turtlesim_gencpp) add_executable(turtle_teleop_key tutorials/teleop_turtle_key.cpp) target_link_libraries(turtle_teleop_key ${catkin_LIBRARIES}) add_dependencies(turtle_teleop_key turtlesim_gencpp) add_executable(draw_square tutorials/draw_square.cpp) target_link_libraries(draw_square ${catkin_LIBRARIES} ${Boost_LIBRARIES}) add_dependencies(draw_square turtlesim_gencpp) add_executable(mimic tutorials/mimic.cpp) target_link_libraries(mimic ${catkin_LIBRARIES}) add_dependencies(mimic turtlesim_gencpp) # 同样指定可执行目标、链接、依赖 install(TARGETS turtlesim_node turtle_teleop_key draw_square mimic RUNTIME DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}) # 安装目标文件到本地系统 install(DIRECTORY images DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION} FILES_MATCHING PATTERN *.png PATTERN *.svg)四、工程实践中遇到的问题总结在一个功能包中将类的函数定义与声明分开文件写用 main.cpp 调用类的声明和定义分开文件下按之前那么处理、分布查看只加这个先生成 library编译成功类的声明和函数定义分开写的生成了这个文件继续加 main.cpp 的只加这个报错很多都没定义加上这个这一条最后去掉了编译也成功 在使用自己的 msg 头文件时必须添加 add_dependencies否则找不到自定义的 msg 产生的头文件报错一样再加报错变了 没有了 ros::init() 这种未定义了说明必须要加上面的是最基本的现在的错误就是没有找到类的定义的函数把这个库加上还是没找到和之前报错一样给上面那个类的定义那个库也加上 target_link_libraries编译就通过了target_link_libraries() 这个功能可能是让其它文件可以定用这个库那么还有个问题 要想用其它功能包的类的函数怎么办官网有详细的解释CMakeLists.txt ROS 官网