《点云库PCL学习教程》第3章PCL基础.ppt

第3章 PCL基础 本章首先简述了PCL C++编程规范，为以后章节的阅读和读者编写出PCL风格的代码做一定铺垫，为了让用户基于PCL开发出自己的扩展，紧接着通过实例详细介绍了在PCL框架下如何建立用户自定义类，最后介绍了PCL中点的已有类型以及如何自定义点类型以满足扩展需求。掌握第3章的内容之后，读者可轻松阅读PCL源码和后续章节中的例子程序，也为读者后续自行开发奠定了基础。 本章各小节目录 3.1 PCL C++编程规范 3.2 如何编写新的PCL类 3.3 PCL已有点类型介绍和增加自定义的点类型 3.4 PCL中异常处理机制 3.1 PCL C++编程规范 架构师为了确保在PCL中所有代码风格的一致性，使得其他开发者及用户容易理解源码，PCL开发者制定并遵循着一套严格的编写规范，PCL的开发者都默认此规范，除非有充足的理由才可以不遵循这些规范。当然这些规范也并不是一成不变的，但提出和更改规则的人需要考虑兼容性，那就是让新加的规则与现有的所有代码相适应。 3.1.1 PCL推荐的命名规范 1. 文件命名 （1）所有的文件名单词之间应该用下划线隔开，例如unordered_map.hpp。 （2）头文件的扩展名为.h。 （3）模板类实现文件的扩展名是.hpp。 （4）源文件的扩展名是.cpp。 2. 目录命名 所有的目录及其子目录命名应该符合，如果由多个单词组成，其之间用下划线隔开，PCL中各个目录遵循以下规则： （1）头文件都应放在源码目录树中的include/下。 （2）模板类实现文件都应放在目录树中的include/ impl/下。 （3）源文件都应放在目录树中的src/下。 3. Include语句 当文件在同一目录下时Include指示语句用双引号，在其他情况下则用尖括号，例如： #include pcl/module_name/file_name.h #include pcl/module_name/impl/file_name.hpp #include “file_name.cpp” //在同一目录下 4. 宏定义命名 宏定义中字母都采用大写格式，为头文件所定义的宏最后面还需要加上下划线，并且名称从include下目录开始，例如pcl/filters/bilateral.h对应PCL_FILTERS_BILATERL_H_。#ifndef和#define定义放在 BSD协议后面代码前面。#endif定义一直在文件结尾，并且加上一句注释掉的宏对应头文件的宏定义，例如： //the BSD license #ifndef PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_//为避免重复包含头文件而定义的宏 #define PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_ //the code #endif //PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_ 5. 命名空间命名 命名空间多于一个单词的，单词之间应该用下划线连接，例如： namespace pcl_io { … } 6. 类/结构命名 类名（和其他自定义类型的名称）应该是CamelCased(驼峰命名)命名规范，也就是连写单词组成命名，每个单词首字母大写。但是有例外：如果类名包含一个缩写，这个缩写应该全部大写，类名和结构名最好是名词组成的名字，例如PFHEstimation代替了EstimatePFH，下面是正确的命名代码例子： class ExampleClass; class PFHEstimation; 7. 函数/成员函数命名 函数和类的成员函数的命名应该采用camelCased，也就是连写单词组成命名，除了首个单词首字母小写其他单词首字母大写，它们的参数命名单词之间用下划线隔开，函数和类的成员函数命名最好采用动词，应该 确保这些名字能清楚的表达函数和类成员函数的功能，例如，checkForErrors()而不是errorCheck()，dumpDataToFile()而不是dataFiledump()，正确的用法： int applyExample(int example_arg); 8. 变量命名 变量的命名应该单词之间用下划线隔开例如： int my_variable; （1）迭代子变量命名。迭代子变量应该反应出它们迭代的对象，例如： std::listint pid_list; std::listint::iterator pid_it; //指示迭代的对象为点的索引 （2）常量命名。常量的名字应该是全大写，例如： const static int MY_CONSTANT = 1000; （3）成员变量命名。类的成员变量命名单词之间用下划线隔开并且以下划线结尾，例如