roadrunner

使用 MATLAB 启动 RoadRunner 应用程序

自 R2022a 起

全页展开

说明

roadrunner 对象使您能够从 MATLAB^® 命令行执行 RoadRunner 应用程序中的常见工作流任务，例如打开、关闭和保存场景和工程。您还可以使用对象函数从文件导入数据并将场景从 RoadRunner 导出为其他格式。

在首次创建 roadrunner 对象之前，您必须以交互方式安装 RoadRunner 并激活您的 RoadRunner 许可证。有关详细信息，请参阅安装并激活 RoadRunner。

roadrunner 对象需要 Automated Driving Toolbox™ 的许可证。

创建对象

语法

rrApp = roadrunner

rrApp = roadrunner(Name=Value)

描述

rrApp = roadrunner 打开 RoadRunner 用于使用 MATLAB settings 函数或 roadrunnerSetup 函数定义的 ProjectFolder 和 InstallationFolder。

示例

rrApp = roadrunner(Name=Value) 使用一个或多个名称-值参量设置其他选项。例如，ProjectFolder=projectFolder 从默认安装文件夹位置启动 RoadRunner，并在 ProjectFolder 指定的位置在现有工程中打开一个新场景。

示例

名称-值参数

全部展开

将可选参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

示例: rrApp = roadrunner(NoDisplay=true,Ports=[54321,54322]) 指定在控制台模式下启动 RoadRunner 而不初始化图形资源，并分别在端口 54321 和 54322 上启动 RoadRunner 和 RoadRunner Scenario API 服务器。

`ProjectFolder` — RoadRunner 工程文件夹路径
字符串标量

RoadRunner 工程文件夹路径，指定为字符串标量。您可以使用 MATLAB settings 函数或 roadrunnerSetup 函数自定义 ProjectFolder 的值。有关 RoadRunner 工程文件夹结构的详细信息，请参阅 RoadRunner 工程和场景系统。

示例: roadrunner("C:\My Project") 打开位于 Windows^® 机器上的 RoadRunner 应用程序中 C:\My Project 文件夹中的工程。

数据类型: string

`Ports` — RoadRunner API 和仿真 API 服务器端口
二元素行向量

RoadRunner API 和仿真 API 服务器端口，指定为 [apiPort , cosimPort] 形式的双元素行向量。虽然 RoadRunner 会在您启动 RoadRunner 应用程序时自动分配默认的 RoadRunner API 服务器端口 (apiPort) 和 RoadRunner Scenario 仿真 API 服务器端口 (cosimPort) 值，但您可以在创建 roadrunner 对象时使用此属性显式分配值，或者通过在现有 roadrunner 对象上使用 connect 函数来分配值。打开 RoadRunner 工程后，RoadRunner 和 RoadRunner Scenario API 服务器将在 localhost:port 本地运行，其中 port 是 API 和仿真 API 服务器端口的值。如果分配的端口不空闲，则会发生连接错误。

示例: rrApp = roadrunner(projectFolder,Ports=[54321,54322]) 分别在端口 54321 和 54322 上启动 RoadRunner 和 RoadRunner Scenario API 服务器。

`InstallationFolder` — 本地 RoadRunner 安装文件夹的位置
字符向量 | 字符串标量

本地 RoadRunner 安装文件夹的位置，以字符向量或字符串标量指定。您可以使用 MATLAB settings 函数或 roadrunnerSetup 函数自定义 InstallationFolder 的值。

这些是 Windows 和 Linux^® 平台上的默认 RoadRunner 安装位置：

Windows — C:\Program Files\RoadRunner R20NNx\bin\win64
Linux, Ubuntu^® — /usr/local/RoadRunner_R20NNx/bin/glnxa64

R20NNx 是您正在使用的发行版本。要自定义 RoadRunner 安装文件夹的默认值，请使用 MATLAB settings 函数或 roadrunnerSetup 函数。

数据类型: char | string

`NoDisplay` — RoadRunner 以主机模式启动
`false` 或 `0` (默认) | `true` 或 `1`

RoadRunner 在非图形环境下以控制台模式启动，该环境指定为逻辑 0 (false) 或 1 (true)。当您将 NoDisplay 设置为 true 时，RoadRunner 不会初始化任何图形资源。这样，即使没有安装显卡或显示服务器的系统，也可以运行 RoadRunner。有关在控制台模式下启动 RoadRunner 的更多详细信息，请参阅在控制台模式下以编程方式控制 RoadRunner。

将 NoDisplay 设置为 true 会限制您使用需要图形资源的功能，例如从 RoadRunner Scenario 导出视频或导出场景 LOD 的俯视图块纹理。要在控制台模式下启用图形相关功能，请将 NoDesktop 设置为 true。

如果将 NoDisplay 设置为 true，则 NoDesktop 必须为 false。

数据类型: logical

`NoDesktop` — RoadRunner 以控制台模式启动并初始化图形资源
`false` 或 `0` (默认) | `true` 或 `1`

RoadRunner 以控制台模式启动，并初始化图形资源，指定为逻辑 0 (false) 或 1 (true)。当您将 NoDesktop 设置为 true 时，RoadRunner 不会显示图形用户界面，但仍然会初始化图形资源以启用依赖于图形的功能，例如从 RoadRunner Scenario 导出视频或导出场景 LOD 的俯视图块纹理。有关在控制台模式下启动 RoadRunner 的更多详细信息，请参阅在控制台模式下以编程方式控制 RoadRunner。

由于 NoDesktop 会使用图形资源，因此对于没有安装显卡或显示服务器的系统，您不能指定此选项。要在没有图形功能的系统上启动 RoadRunner，请将 NoDisplay 设置为 true。

如果将 NoDesktop 设置为 true，则 NoDisplay 必须为 false。

数据类型: logical

属性

全部展开

`InstallationFolder` — 本地 RoadRunner 安装文件夹的位置
字符向量 | 字符串标量

此属性在创建对象后是只读的。要设置此属性，请在创建 roadrunner 对象时使用 InstallationFolder 参量。

本地 RoadRunner 安装文件夹的位置，以字符向量或字符串标量指定。您可以使用 MATLAB settings 函数或 roadrunnerSetup 函数自定义 InstallationFolder 的值。

这些是 Windows 和 Linux 平台上的默认 RoadRunner 安装位置：

Windows — C:\Program Files\RoadRunner R20NNx\bin\win64
Linux, Ubuntu — /usr/local/RoadRunner_R20NNx/bin/glnxa64

R20NNx 是您正在使用的发行版本。要自定义 RoadRunner 安装文件夹的默认值，请使用 MATLAB settings 函数或 roadrunnerSetup 函数。

数据类型: char | string

`Version` — 当前运行的 RoadRunner 实例的版本号
只读: 字符串标量

此属性为只读。

当前正在运行的 RoadRunner 实例的版本号，以字符串标量表示。

`NoDisplay` — RoadRunner 以主机模式启动
`false` 或 `0` (默认) | `true` 或 `1`

此属性在创建对象后是只读的。要设置此属性，请在创建 roadrunner 对象时使用 NoDisplay 参量。

如果将 NoDisplay 设置为 true，则 NoDesktop 必须为 false。

数据类型: logical

`NoDesktop` — RoadRunner 以控制台模式启动并初始化图形资源
`false` 或 `0` (默认) | `true` 或 `1`

此属性在创建对象后是只读的。要设置此属性，请在创建 roadrunner 对象时使用 NoDesktop 参量。

如果将 NoDesktop 设置为 true，则 NoDisplay 必须为 false。

数据类型: logical

对象函数

全部展开

项目

`newProject`	使用 MATLAB 创建新的 RoadRunner 工程
`openProject`	使用 MATLAB 打开 RoadRunner 工程
`saveProject`	使用 MATLAB 保存 RoadRunner 工程

场景

`newScene`	使用 MATLAB 创建新的 RoadRunner 场景
`openScene`	使用 MATLAB 打开 RoadRunner 场景
`saveScene`	使用 MATLAB 保存 RoadRunner 场景
`exportScene`	使用 MATLAB 导出 RoadRunner 场景
`exportCustomFormat`	使用 MATLAB 将 RoadRunner 场景导出为自定义格式
`importScene`	使用 MATLAB 将场景导入 RoadRunner

应用情境

`newScenario` (RoadRunner Scenario)	Create new scenario in RoadRunner Scenario using MATLAB
`openScenario` (RoadRunner Scenario)	Open scenario in RoadRunner Scenario using MATLAB
`saveScenario` (RoadRunner Scenario)	Save scenario in RoadRunner Scenario using MATLAB
`exportScenario` (RoadRunner Scenario)	Export scenario from RoadRunner Scenario using MATLAB
`importScenario` (RoadRunner Scenario)	Import file into RoadRunner Scenario using MATLAB
`createSimulation` (RoadRunner Scenario)	Create RoadRunner Scenario simulation using MATLAB
`prepareSimulation` (RoadRunner Scenario)	Submit simulation data to RoadRunner Scenario simulation engine using MATLAB
`simulateScenario` (RoadRunner Scenario)	Simulate RoadRunner scenario using MATLAB
`getScenarioVariable` (RoadRunner Scenario)	Get the value of RoadRunner scenario variable using MATLAB
`setScenarioVariable` (RoadRunner Scenario)	Set RoadRunner scenario variable using MATLAB
`setCameraMode` (RoadRunner Scenario)	Set camera mode to visualize RoadRunner scenario simulation using MATLAB
`remapAnchor` (RoadRunner Scenario)	Remap anchors in RoadRunner Scenario in MATLAB
`getAnchors` (RoadRunner Scenario)	Retrieve anchor attributes from RoadRunner scenario using MATLAB
`exportActorTrajectoryToCSV` (RoadRunner Scenario)	Export trajectories of actors in RoadRunner scenario to comma-separated values (CSV) files using MATLAB
`exportVideo` (RoadRunner Scenario)	Export RoadRunner scenario simulation data to video file using MATLAB

连接、关闭和状态

`roadrunner.connect`	使用 MATLAB 连接到 RoadRunner 的打开实例
`close`	使用 MATLAB 关闭 RoadRunner
`status`	使用 MATLAB 获取 RoadRunner 的当前状态

示例

全部折叠

从默认安装文件夹启动 RoadRunner 应用程序

此示例使用:

打开实时脚本

使用 ProjectFolder 变量指定现有工程的路径。例如，此代码显示 Windows® 计算机上位于 C:\RR\MyProject 的工程路径。

projectFolder = "C:\RR\MyProject";

创建一个 roadrunner 对象并通过指定用来创建场景的工程位置来打开 RoadRunner。此示例假设 RoadRunner 安装在其默认位置。

rrApp = roadrunner(ProjectFolder=projectFolder, InstallationFolder='C:\Program Files\RoadRunner R2023b\bin\win64');

更改默认 RoadRunner 安装文件夹设置

此示例使用:

打开实时脚本

使用 MATLAB settings 函数修改默认 RoadRunner 安装文件夹设置。

您可以使用 InstallationFolder 函数为 roadrunner 对象的 settings 属性指定一个值，该值在整个 MATLAB 会话中持续存在，或者为给定的 MATLAB 会话持续存在。

要为 InstallationFolder property 设置持久默认值，请编辑 PersonalValue 的值。指定的值对于单个用户在多个 MATLAB 会话中保持不变。

s = settings;
s.roadrunner.application.InstallationFolder.PersonalValue = "C:\Program Files\RoadRunner R2022a\bin\win64";

您还可以为 InstallationFolder 属性设置临时默认值。指定的值仅在当前 MATLAB 会话中有效，并在会话结束时被清除。

s = settings;
s.roadrunner.application.InstallationFolder.TemporaryValue = "C:\MyRoadRunner Install\bin\win64";

同时启动多个 RoadRunner 应用程序实例

此示例使用:

打开实时脚本

通过创建 roadrunner 对象的多个实例来打开多个 RoadRunner 应用程序。您可以使用每个实例以编程方式与其打开的 RoadRunner 应用程序进行交互。默认情况下，此代码中使用的场景包含在 RoadRunner 工程中。

通过指定 Lane Keep 工程打开 RoadRunner 的第一个实例。在这个例子中，工程位于路径 C:\RR\Lane Keep 上。

rrApp1 = roadrunner("C:\RR\Lane Keep");

打开第一个工程中的 FourWaySignal 场景。

openScene(rrApp1,"FourWaySignal.rrscene");

通过指定 USCity 工程打开 RoadRunner 的第二个实例。在此示例中，工程位于路径 C:\RR\USCity 上。

rrApp2 = roadrunner("C:\RR\USCity");

打开第二个工程中的 SanAntonio 场景

openScene(rrApp2,"SanAntonio.rrscene");

以控制台模式启动 RoadRunner 应用程序

此示例使用:

打开实时脚本

使用 projectFolder 变量指定现有工程的路径。例如，此代码显示 Windows® 计算机上位于 C:\RR\MyProject 的工程路径。

projectFolder = "C:\RR\MyProject";

创建一个 roadrunner 对象并通过指定用来创建场景的工程位置来打开 RoadRunner。此示例假设 RoadRunner 安装在其默认位置。指定 NoDisplay 属性以使用非图形终端在控制台模式下启动应用程序。

rrApp = roadrunner(projectFolder,InstallationFolder="C:\Program Files\RoadRunner R2022b\bin\win64",NoDisplay=true);

限制

roadrunner 对象及其相关函数仅在 RoadRunner R2022a 及更高版本中受支持。
创建 projectFolder 对象时，使用 roadrunner 参数指定的工程必须已存在。
projectFolder 参数和 InstallationFolder 属性不支持路径中的 Unicode 字符。
roadrunner 对象及其关联函数在 MATLAB Online™ 中不受支持。

提示

从 MATLAB 工作区中删除 roadrunner 对象不会关闭与其关联的 RoadRunner 应用程序。您必须手动关闭 RoadRunner 应用程序。此外，退出当前 MATLAB 会话不会关闭由 roadrunner 创建的任何 RoadRunner 应用程序。

版本历史记录

在 R2022a 中推出

全部展开

R2025b_plus: 更改显示选项

从 R2025b Update 2 开始，NoDisplay 指定 RoadRunner 以控制台模式启动，而不初始化任何图形资源。这项更改使您可以在未安装显卡或显示服务器的系统上运行 RoadRunner。但是，由于 RoadRunner 不初始化图形资源，因此您无法使用依赖于图形的功能，例如从 RoadRunner Scenario 导出视频或导出场景 LOD 的俯视图块纹理。

在之前的版本中，将 NoDisplay 指定为 true 会以控制台模式启动 RoadRunner，但仍然会初始化图形资源。要从 R2025b Update 2 开始重现此旧行为，请将 NoDesktop 指定为 true。此选项允许您使用图形相关功能。

R2025a: 将情境中交通参与者的轨迹导出到 CSV 文件

您现在可以使用新的 exportActorTrajectoryToCSV 对象函数情境中交通参与者的轨迹导出到 CSV 文件。

另请参阅

roadrunner

说明

创建对象

语法

描述

名称-值参数

ProjectFolder — RoadRunner 工程文件夹路径 字符串标量

Ports — RoadRunner API 和仿真 API 服务器端口 二元素行向量

InstallationFolder — 本地 RoadRunner 安装文件夹的位置 字符向量 | 字符串标量

NoDisplay — RoadRunner 以主机模式启动 false 或 0 (默认) | true 或 1

NoDesktop — RoadRunner 以控制台模式启动并初始化图形资源 false 或 0 (默认) | true 或 1

属性

InstallationFolder — 本地 RoadRunner 安装文件夹的位置 字符向量 | 字符串标量

Version — 当前运行的 RoadRunner 实例的版本号 只读: 字符串标量

NoDisplay — RoadRunner 以主机模式启动 false 或 0 (默认) | true 或 1

NoDesktop — RoadRunner 以控制台模式启动并初始化图形资源 false 或 0 (默认) | true 或 1

对象函数

项目

场景

应用情境

连接、关闭和状态

示例

从默认安装文件夹启动 RoadRunner 应用程序

更改默认 RoadRunner 安装文件夹设置

同时启动多个 RoadRunner 应用程序实例

以控制台模式启动 RoadRunner 应用程序

限制

提示

版本历史记录

R2025b_plus: 更改显示选项

R2025a: 将情境中交通参与者的轨迹导出到 CSV 文件

另请参阅

主题

`ProjectFolder` — RoadRunner 工程文件夹路径
字符串标量

`Ports` — RoadRunner API 和仿真 API 服务器端口
二元素行向量

`InstallationFolder` — 本地 RoadRunner 安装文件夹的位置
字符向量 | 字符串标量

`NoDisplay` — RoadRunner 以主机模式启动
`false` 或 `0` (默认) | `true` 或 `1`

`NoDesktop` — RoadRunner 以控制台模式启动并初始化图形资源
`false` 或 `0` (默认) | `true` 或 `1`

`InstallationFolder` — 本地 RoadRunner 安装文件夹的位置
字符向量 | 字符串标量

`Version` — 当前运行的 RoadRunner 实例的版本号
只读: 字符串标量

`NoDisplay` — RoadRunner 以主机模式启动
`false` 或 `0` (默认) | `true` 或 `1`

`NoDesktop` — RoadRunner 以控制台模式启动并初始化图形资源
`false` 或 `0` (默认) | `true` 或 `1`