【Apollo CyberRT】源码分析之 “component” 模块

news2025/1/16 8:10:02

代码位置

apollo/cyber/component

功能

在自动驾驶系统中，模块（如感知、定位、控制系统等）在 Cyber RT 下以 Component 的形式存在。不同 Component 之间通过 Channel 进行通信。Component 概念不仅解耦了模块，还为将模块拆分为多个子模块提供了灵活性。

Component类是各个组件的基类实现，组件类似与ros里的node，每个算法模块都可以自己实现为一个Component的基类，从而加入到CyberRT的框架中。

实际上Component分为2类：

一类是消息驱动的Component，
第二类是定时调用的TimerComponent。

定时调度模块没有绑定消息收发，需要用户自己创建reader来读取消息，如果需要读取多个消息，可以创建多个reader。

使用示例

使用可以参考cyber的示例程序：cyber/examples/common_component_example/

也可以看具体某个模块，比如感知模块的激光障碍物检查的component
可以看到对外的接口只有 Init() 和 Proc() 用于初始化组件以及执行组件的核心功能。
使用源码中的一句话：
The Init & Proc functions need to be overloaded, but don’t want to be called. They are called by the CyberRT Frame.

代码结构

代码事实上并不多

源码分析

类图关系

在这里插入图片描述

ComponentBase

Component类和TimerComponent类的基类
非模板类，无需模板参数
定义了接口函数和几个基础功能函数（比如LoadConfigFiles）

Component

继承ComponentBase，有四个模板参数, 每个模板参数表示一个消息，即一个component最多可以处理 4 个消息信道，
这些信道，即 Reader 对象，最后都会被放入到 ComponentBase::readers_ 变量中

 * @tparam M0 the first message.
 * @tparam M1 the second message.
 * @tparam M2 the third message.
 * @tparam M3 the fourth message.
 * @warning The Init & Proc functions need to be overloaded, but don't want to
 * be called. They are called by the CyberRT Frame.
 *
 */
template <typename M0 = NullType, typename M1 = NullType,
          typename M2 = NullType, typename M3 = NullType>
class Component : public ComponentBase {... ...}

Component类中只有5个函数，还是比较简单的，具体的5个函数如下：

 public:
  Component() {}
  ~Component() override {}

  /**
   * @brief init the component by protobuf object.
   *
   * @param config which is defined in 'cyber/proto/component_conf.proto'
   *
   * @return returns true if successful, otherwise returns false
   */
  bool Initialize(const ComponentConfig& config) override;
  bool Process(const std::shared_ptr<M0>& msg0, const std::shared_ptr<M1>& msg1,
               const std::shared_ptr<M2>& msg2,
               const std::shared_ptr<M3>& msg3);

 private:
  /**
   * @brief The process logical of yours.
   *
   * @param msg0 the first channel message.
   * @param msg1 the second channel message.
   * @param msg2 the third channel message.
   * @param msg3 the fourth channel message.
   *
   * @return returns true if successful, otherwise returns false
   */
  virtual bool Proc(const std::shared_ptr<M0>& msg0,
                    const std::shared_ptr<M1>& msg1,
                    const std::shared_ptr<M2>& msg2,
                    const std::shared_ptr<M3>& msg3) = 0;