sltest.xil.framework.FrameworkConfiguration Class

Namespace: sltest.xil.framework

Configure test bench ports and variable mapping

Since R2022a

Add-On Required

This class requires that you Install and Set Up the Simulink Test Support Package for ASAM XIL Standard.

Description

Use the sltest.xil.framework.FrameworkConfiguration methods to add ports and map host variables to variables on the test bench. These methods do not become active until you call the init method of sltest.xil.framework.Framework.

The sltest.xil.framework.FrameworkConfiguration class is a handle class.

Creation

You cannot create an sltest.xil.framework.FrameworkConfiguration object. A Configuration object exists only as a member of an sltest.xil.framework.Framework object. Create a Framework object, then use the FrameworkConfiguration methods from within that Framework object.

Methods

expand all

Public Methods

`addModelAccessPort`	`addModelAccessPort(portname,benchtype)` `addModelAccessPort(portname,benchtype,Name=Value)` Creates a model access port to control a model running on the specified test bench. Inputs `portName` — Unique name to assign to the port, specified as a character vector. `benchtype` — Test bench type, specified as `'asamxil.v2_1'`. Name-Value Pairs Specify optional pairs of arguments as `Name1=Value1,...,NameN=ValueN`, where `Name` is the argument name and `Value` is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter. `VendorName` — Test bench vendor name, specified as a string or character vector. `ProductName` — Test bench product name, specified as a string or character vector. `ProductVersion` — Test bench product version, specified as a string or character vector. `PortConfigFile` — Path of the configuration file, specified as a string or character vector. `InitOrder` — Order in which the port starts, specified as an integer. `ShutdownOrder` — Order in which the port shuts down, specified as an integer. `TargetState` — Initial state of the port, which by default is the current port state. You can specify the `TargetState` as `'started'` to start the port or `'stopped'` to stop the port when `framework.init` is called, or as a string that includes an ASAM^® XIL enumerated name. See Configure a Model Access Port and Map a Variable.
`addECUCalibrationPort`	`addECUCalibrationPort(portname,benchtype)` Creates an electronic control unit (ECU) calibration port that tunes the parameters of an ECU. `addECUCalibrationPort` uses the same inputs and name-value pairs as the `addModelAccessPort` method. For example: frm.Configuration.addECUCalibrationPort(... 'ECUCPort',... 'asamxil.v2_1',... VendorName = 'MathWorks',... ProductName ='XIL API',... ProductVersion = '1.0',... PortConfigFile = fullfile(pwd,... 'myConfigureFile.xml'),... TargetState = 'started');
`addECUMeasurementPort`	`addECUMeasurementPort(portname,benchtype)` Creates an ECU measurement port that captures and measures data from an ECU. `addECUMeasurementPort` uses the same inputs and name-value pairs as the `addModelAccessPort` method.
`addTestVariableMapping`	`addTestVariableMapping(testvarname,benchvarport,benchvarname)` `addTestVariableMapping(testvarname,benchvarport,benchvarname,TaskName=name)` Creates a mapping from a test variable name to a test bench variable. You can specify any desired name for the test variable name, but it must be unique within the framework. Optionally, specify the `TaskName`, as a character vector, to use for the specified variable. A task is the rate at which data logging, which is controlled through the `Acquisition` class, occurs for a test variable. If you don't specify a task for a variable, it is logged using the first task value returned by the `displayAllTaskInfo` method of `sltest.xil.framework.Framework`. For Simulink^® Real-Time™, the rate is the same as the sampling rates of the model. Inputs `testvarname` — Test variable name, specified as a character vector. `benchvarport` — Port associated with the test bench variable, specified as a character vector. `benchvarname` — Variable name on the test bench, specified as a character vector.

Examples

collapse all

Configure a Model Access Port and Map a Variable

This example shows how to:

Create a framework object
Add a model access port for the ABC Co. test bench
Map the RPM test variable to the simpleXIL/Gain:1 variable on the test bench and specify the logging rate (Task) for RPM as SubRate1
Initialize the test bench
Create a variable object to use in the test, using the RPM mapping

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

frm.Configuration.addModelAccessPort(...
    'MAPort1','asamxil.v2_1',...
    VendorName='ABC Co.',...
    ProductName='ABC Test Bench',...
    ProductVersion='1.7',...
    PortConfigFile=fullfile(pwd,'myConfigFile.xml'));

frm.Configuration.addTestVariableMapping(...
    'RPM','MAPort1','simpleXIL/Gain:1'...
    'TaskName','SubRate1');

frm.init;

rpm = frm.createVariable('RPM');

Version History

Introduced in R2022a