Ardusub源码剖析——GCS_Mavlink.h

代码

#pragma once

#include <GCS_MAVLink/GCS.h>

class GCS_MAVLINK_Sub : public GCS_MAVLINK {

public:

    using GCS_MAVLINK::GCS_MAVLINK;

protected:

    uint32_t telem_delay() const override {
        return 0;
    };

    MAV_RESULT handle_flight_termination(const mavlink_command_long_t &packet) override;

    uint8_t sysid_my_gcs() const override;

    MAV_RESULT handle_command_do_set_roi(const Location &roi_loc) override;
    MAV_RESULT _handle_command_preflight_calibration_baro() override;
    MAV_RESULT _handle_command_preflight_calibration(const mavlink_command_long_t &packet) override;
    MAV_RESULT handle_command_long_packet(const mavlink_command_long_t &packet) override;

    // override sending of scaled_pressure3 to send on-board temperature:
    void send_scaled_pressure3() override;

    int32_t global_position_int_alt() const override;
    int32_t global_position_int_relative_alt() const override;

    bool set_home_to_current_location(bool lock) override WARN_IF_UNUSED;
    bool set_home(const Location& loc, bool lock) override WARN_IF_UNUSED;

    void send_banner() override;

    void send_nav_controller_output() const override;
    void send_pid_tuning() override;

    uint64_t capabilities() const override;

private:

    void handleMessage(const mavlink_message_t &msg) override;
    bool handle_guided_request(AP_Mission::Mission_Command &cmd) override;
    void handle_change_alt_request(AP_Mission::Mission_Command &cmd) override;
    bool try_send_message(enum ap_message id) override;

    bool send_info(void);

    MAV_MODE base_mode() const override;
    MAV_STATE vehicle_system_status() const override;

    int16_t vfr_hud_throttle() const override;

};

剖析

C++类的声明，它继承自一个名为 GCS_MAVLINK 的基类。这个类 GCS_MAVLINK_Sub 是为了处理与 MAVLink（一种通信协议，用于无人机和地面控制站之间的通信）相关的消息，并且它重写（override）了基类中的多个虚函数，以提供特定于该子类的实现。

#pragma once

这是一个预处理器指令，用于确保文件只被包含一次，类似于在头文件中使用 #ifndef, #define, 和 #endif 宏来防止重复包含。

#include <GCS_MAVLink/GCS.h>

这行代码包含了另一个头文件，该头文件包含了 GCS_MAVLINK 类的定义。

class GCS_MAVLINK_Sub : public GCS_MAVLINK {

这里声明了一个名为 GCS_MAVLINK_Sub 的类，它继承自 GCS_MAVLINK 类，意味着它继承了 GCS_MAVLINK 的所有公共和受保护的成员。

public:

以下成员属于公共部分，可以被外部访问。

    using GCS_MAVLINK::GCS_MAVLINK;

这是一个使用声明，它使得 GCS_MAVLINK 的构造函数在 GCS_MAVLINK_Sub 中也是可访问的。

protected:

以下成员属于受保护部分，它们可以被派生类和基类的成员函数访问。

    uint32_t telem_delay() const override {
        return 0;
    };

这是一个重写基类虚函数 telem_delay 的成员函数，它返回一个 uint32_t 类型的值，这里简单地返回了0。

以下是一些其他重写的成员函数的声明：

    MAV_RESULT handle_flight_termination(const mavlink_command_long_t &packet) override;
    uint8_t sysid_my_gcs() const override;
    // ... 其他函数声明 ...

这些函数都是重写基类的虚函数，用于处理不同的 MAVLink 消息和命令。

    void send_scaled_pressure3() override;
    // ... 其他函数声明 ...

这个函数也是重写基类的虚函数，用于发送修改后的压力数据。

    bool set_home_to_current_location(bool lock) override WARN_IF_UNUSED;
    bool set_home(const Location& loc, bool lock) override WARN_IF_UNUSED;

这些函数用于设置无人机的家位置，WARN_IF_UNUSED 是一个编译器指令，用于在函数未被使用时发出警告。

    void send_banner() override;
    // ... 其他函数声明 ...

这个函数用于发送一些形式的横幅信息。

private:

以下成员属于私有部分，只能被类的内部成员函数访问。

    void handleMessage(const mavlink_message_t &msg) override;
    // ... 其他函数声明 ...

这个函数用于处理接收到的 MAVLink 消息。

    MAV_MODE base_mode() const override;
    MAV_STATE vehicle_system_status() const override;
    // ... 其他函数声明 ...

这些函数用于获取系统的模式和状态。