sltest.xil.framework.Framework 类

命名空间: sltest.xil.framework

初始化测试平台，启动和停止仿真，并显示测试平台、变量和任务

自 R2022a 起

需要附加组件

本课程要求您安装并设置 ASAM XIL 标准的 Simulink Test 支持包。

描述

sltest.xil.framework.Framework 是允许使用 Simulink^® Test™ 支持 ASAM^® XIL 标准的包的其他对象的类。您必须创建一个 Framework 对象才能访问其他 sltest.xil 功能：

sltest.xil.framework.FrameworkConfiguration — 配置测试平台端口和测试变量映射。
sltest.xil.framework.TestVariable — 读取和写入映射到测试平台的变量。
sltest.xil.framework.Acquisition — 控制测试平台的信号数据记录并检索记录的数据。
sltest.xil.framework.Stimulation — 控制测试平台的外部输入。

sltest.xil.framework.Framework 类是 handle 类。

创建对象

描述

示例

frm = sltest.xil.framework.Framework 创建一个 Framework 对象。

属性

全部展开

`Configuration` — 框架配置
`FrameworkConfiguration` 对象

框架配置，指定为 sltest.xil.framework.FrameworkConfiguration 对象。

属性：

`GetAccess`	`public`
`SetAccess`	`protected`

`Acquisition` — 控制和检索记录的数据
`Acquisition` 对象

控制信号数据在测试平台记录并检索记录的数据，指定为 sltest.xil.framework.Acquisition 对象。

属性：

`GetAccess`	`public`
`SetAccess`	`protected`

`Stimulation` — 控制外部输入
`Stimulation` 对象

控制测试平台的外部输入，指定为 sltest.xil.framework.Stimulation 对象。

属性：

`GetAccess`	`public`
`SetAccess`	`protected`

方法

全部展开

公共方法

`init`	`init` 创建并连接到已配置的测试平台。您必须先使用 `init` 才能运行其他 `Framework` 方法。调用 `init` 仅启动其 `TargetState` 名称-值对从 `sltest.xil.framework.FrameworkConfiguration` 设置为 `'started'` 的端口。
`start`	`start` 开始仿真和其他测试过程。调用 `start` 启动所有端口。要控制端口启动的顺序，请在添加和配置端口时指定顺序（参见 `sltest.xil.framework.FrameworkConfiguration` 的 `InitOrder` 名称-值对）。
`stop`	`stop` 停止仿真和其他测试过程。要控制端口何时停止，请在添加和配置端口时指定顺序（请参阅 `sltest.xil.framework.FrameworkConfiguration` 的 `ShutdownOrder` 名称-值对）。
`shutdown`	`shutdown` 关闭仿真并释放框架分配的所有资源。
`createVariable`	`testvar = createVariable(testvarname)` 创建一个与测试平台的测试变量相对应的 `TestVariable` 对象。在测试主体中使用 `createVariable`，它指定配置期间映射的变量名称。通过将变量重新映射到新测试平台的变量，在测试体中调用 `createVariable` 可以让您使用该测试体，而无需在其他测试平台上进行任何更改。建议的工作流程是在调用 `init` 方法后立即创建测试变量。输入 `testVariableName` — 用于创建的测试变量的名称，指定为字符向量。该名称是映射的测试变量名称之一。有关映射的信息，请参阅 `sltest.xil.framework.FrameworkConfiguration` 的 `addTestVariableMapping` 方法。输出 `testvar` — 创建的测试变量，作为 `sltest.xil.framework.TestVariable` 对象返回。
`loadConfiguration`	`loadConfiguration(configfile)` 将 ASAM XIL 框架配置文件加载到框架的配置中。输入 `configfile` — 框架配置文件的路径，指定为字符向量。
`waitForSimulationComplete`	`waitForSimulationComplete` `tf = waitForSimulationComplete(Timeout=Value)` 等待仿真完成。可选地，将 `Timeout` 指定为双精度值，表示等待仿真完成的秒数。此方法仅适用于模型接入端口。输出 `tf` — 如果指定 `Timeout`，则如果仿真在指定的超时内完成，则返回 `true`，如果仿真在完成之前超时，则返回 `false`。
`pushDataToSimulinkTestManager`	`pushDataToSimulinkTestManager(testcase,data)` 将记录的测试用例数据作为 `Simulink.SimulationData.Dataset` 对象推送到测试管理器，这是 `sltest.xil.framework.Acquisition` 的 `fetch` 方法的输出。仅当您在测试管理器中运行代码时才可以使用此方法。输入 `testcase` —测试用例的名称，指定为 `sltest.TestCase` 对象。 `data` — 通过 `fetch` 方法获得的测试记录的数据，指定为 `fetch` 命令的输出变量名。
`displayAvailableTestbenches`	`displayAvailableTestbenches` 显示可用的 ASAM XIL 测试平台。在创建端口或配置之前或之后使用此方法。
`displayAllTestbenchVariables`	`displayAllTestbenchVariables` 显示所有端口的所有测试平台变量。在使用 `displayAllTestbenchVariables` 方法之前，请通过添加端口来配置测试平台，然后调用 `init` 方法。
`displayAllTaskInfo`	`displayAllTaskInfo` 显示所有端口的测试平台任务名称。任务是记录测试变量数据的速率。在使用 `displayAllTaskInfo` 方法之前，请通过添加端口来配置测试平台，然后调用 `init` 方法。
`getAvailableTestbenches`	`tbenches = getAvailableTestbenches(tbenchtype)` 返回指定类型的可用 ASAM XIL 测试平台。您可以在创建端口或配置之前使用此方法。输入 `tbenchtype` — 测试平台类型，指定为 `'asamxil.v2_1'`。输出 `tbenches` — 可用的测试平台，以带有 `VendorName`、`ProductName`、`ProductVersion` 和 `XILVersion` 字段的结构体返回。
`getTestbenchVariableNames`	`varnames = getTestbenchVariableNames(portname)` 返回指定端口的测试平台变量名称。在显示变量名称之前，请通过添加端口来配置测试平台，然后调用 `init` 方法。输入 `portname` — 返回关联变量名称的端口名称，指定为字符向量。输出 `varnames` — 变量名称，以字符向量元胞数组形式返回。
`getTaskNames`	`taskname = getTaskNames(portname)` 返回指定端口的测试平台任务名称。任务是记录测试变量数据的速率。在使用 `getTaskNames` 方法之前，请通过添加端口来配置测试平台，然后调用 `init` 方法。输入 `portname` — 返回关联任务名称的端口名称，指定为字符向量。您使用 `sltest.xil.framework.FrameworkConfiguration` 方法为特定类型的端口创建端口名称。输出 `taskname` — 与指定端口相关的任务的名称，以字符向量元胞数组形式返回。您可以使用 `sltest.xil.framework.FrameworkConfiguration` 的 `addTestVariableMapping` 方法定义任务名称。
`getTaskInfo`	`taskinfo = getTaskInfo(portname)` 返回有关给定端口的任务的信息。任务是记录测试变量数据的速率。在使用 `getTaskInfo` 方法之前，请通过添加端口来配置测试平台，然后调用 `init` 方法。输入 `portname` — 返回相关任务信息的端口名称，指定为字符向量。输出 `taskinfo` — 有关任务的信息，以结构元胞数组的形式返回。

示例

全部折叠

显示所有测试平台变量和任务

此示例演示如何：

创建一个 Framework 对象
配置模型访问端口
初始化框架
显示测试平台变量及其记录率（Task）信息。

注意

此示例中的配置值是占位符。要设置测试平台的值，请参阅使用 Simulink Test 支持包（针对 ASAM XIL 标准）进行实时测试。

import sltest.xil.framework.*;
frm = Framework;

frm.Configuration.addModelAccessPort(...
   'MAPort1', ...
   'asamxil.v2_1', ...
   'VendorName','ABC Co.', ...
   'ProductName','ABC Test Bench', ...
   'ProductVersion','2020_1', ...
   'PortConfigFile',fullfile(pwd,'myABC_MAPPortConfig.xml'));

frm.init;

frm.displayAllTestbenchVariables;
frm.displayAllTaskInfo;

检索并绘制记录的仿真数据

此示例演示如何：

创建一个 Framework 对象
配置模型访问端口
将 Signal 测试变量映射到 Model/Integ1/Output1 测试平台变量
初始化框架
创建 Signal 变量的实例
设置并启动采集，以及启动和停止仿真
获取结果数据并绘制结果

注意

此示例中的配置和变量映射值是占位符。要设置测试平台的值，请参阅使用 Simulink Test 支持包（针对 ASAM XIL 标准）进行实时测试。

import sltest.xil.framework.*;
frm = Framework;

frm.Configuration.addModelAccessPort(...
   'MAPort1', ...
   'asamxil.v2_1', ...
   'vendorName','ABC Co.', ...
   'productName','ABC Test Bench', ...
   'productVersion','2020_1', ...
   'portConfigFile',fullfile(pwd,'myABC_MAPPortConfig.xml'));

frm.Configuration.addTestVariableMapping(...
   'Signal','MAPort1','Model/Integ1/Output1');

frm.init;

signal = frm.createVariable('Signal');
frm.Acquisition.setupWithVariables(signal);
frm.Acquisition.start;
frm.start;
pause(2);
frm.stop;

result = frm.Acquisition.fetch;
hold on;
for i = 1:result.numElements
    plot(result{i}.Values.Time,result{i}.Values.Data);
end
hold off;