C++#

本指南提供了有关如何使用 VEXcode V5 中提供的 C++ 类的详细信息。

每个设备或系统都用一个 C++ 类表示。类页面包含以下信息：

  • 构造函数 – 如何创建类的实例。

  • 成员函数 – 您可以对该实例调用的函数。

  • 其他 API 元素 – 其他元素，例如属性、控制序列或相关类型（如适用）。

API 参考类别#

按设备、系统或编程特性浏览 C++ API：

  • 传动系统 – 控制带有或不带有惯性传感器、GPS 传感器或陀螺仪传感器的传动系统。

  • 电机和电机控制器 – 控制智能电机和传统电机控制器。

  • 控制器 – V5 控制器输入、输出、按钮、操纵杆和屏幕交互。

  • 大脑 – V5 大脑屏幕绘制，并检索系统信息。

  • Competition – 竞赛控制结构，包括如何为自动驾驶和驾驶员控制模式编写代码。

  • 智能端口设备 – 连接到 V5 智能端口的设备。

  • 3线设备 – 连接到3线端口的设备。

  • Console – 控制台打印和输出格式。

  • 逻辑 – 核心编程功能，例如控制流、变量、函数、事件、数学工具、线程和计时工具。

  • VEXlink – 使用有线或无线连接在多个 V5 大脑之间进行通信。

  • CTE 工作单元 – 控制和配置 CTE 工作单元系统所需的类和实用程序。

了解 API 条目#

每个 API 条目都经过精心组织，旨在帮助您快速了解函数、构造函数或属性的作用以及如何在代码中使用它们。

根据 API 元素的类型，您可能会看到以下几个部分：

  • 描述 – 解释函数或元素的作用以及它在代码中产生的影响。

  • 可用函数 / 语法 – 显示您必须使用的确切 C++ 语法。如果存在多个版本，则会分别列出。

  • 参数 – 描述您可以提供的输入，包括有效值和单位。

  • 返回值 – 说明函数返回什么值（如果有的话）。

  • 注释 – 突出显示重要行为、限制或与其他功能的交互。

  • 示例 – 提供带注释的 C++ 代码，演示该函数的常用用法。

并非每个条目都包含所有部分。较简单的函数可能只包含语法和返回值信息，而更高级的功能可能包含详细的注释和复杂的示例。

所有代码示例都力求实用且贴近实际，因此您可以将其复制粘贴到自己的项目中，只需进行少量修改。

API 条目示例#

下面是一个简化的示例，展示了典型的函数输入是如何结构的：

stop

停止传动系统。

Available Functions

1 — 使用当前配置的停止模式 停止传动系统。

void stop();

2 — 使用指定的制动模式停止传动系统。

void stop(
    brakeType mode );
Parameters

范围

类型

描述

mode

brakeType

The brake type to use when stopping the drivetrain:

  • brake — Stops immediately.
  • coast — Slows gradually to a stop.
  • hold — Stops and resists movement using motor feedback.
Return Values

此函数不返回值。

Examples 
// Drive forward, then coast to a stop
myDrivetrain.setDriveVelocity(100, percent);
myDrivetrain.drive(forward);
wait(2, seconds);
myDrivetrain.stop(coast);
On this page