sltest.xil.framework.Framework Class

Namespace: sltest.xil.framework

Initialize test bench, start and stop simulation, and display test bench, variable, and task

Since R2022a

Add-On Required

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

Description

sltest.xil.framework.Framework is the class that enables using other objects of the Simulink^® Test™ Support Package for ASAM^® XIL Standard. You must create a Framework object to access other sltest.xil functionality:

• sltest.xil.framework.FrameworkConfiguration — Configure test bench ports and test variable mapping.

• sltest.xil.framework.TestVariable — Read and write variables mapped to test bench.

• sltest.xil.framework.Acquisition — Control signal data logging on test bench and retrieve logged data.

• sltest.xil.framework.Stimulation — Control external input to test bench.

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

Creation

Description

frm = sltest.xil.framework.Framework creates a Framework object.

Properties

Configuration — Framework configuration

FrameworkConfiguration object

Framework configuration, specified as a sltest.xil.framework.FrameworkConfiguration object.

Attributes:

GetAccess	public
SetAccess	protected

Acquisition — Control and retrieve logged data

Acquisition object

Control signal data logging on the test bench and retrieve logged data, specified as a sltest.xil.framework.Acquisition object.

Attributes:

GetAccess	public
SetAccess	protected

Stimulation — Control external input

Stimulation object

Control external input to the test bench, specified as a sltest.xil.framework.Stimulation object.

Attributes:

GetAccess	public
SetAccess	protected

Methods

Public Methods

init	init Creates and connects to the configured test benches. You must use init before you can run other Framework methods. Calling init starts only the ports that have their TargetState name-value pair of sltest.xil.framework.FrameworkConfiguration set to 'started'.
start	start Start the simulation and other testing processes. Calling start starts all ports. To control the order in which the ports start, specify the order when adding and configuring the ports (see InitOrder name-value pair of sltest.xil.framework.FrameworkConfiguration).
stop	stop Stop the simulation and other testing processes. To control when the ports stop, specify the order when adding and configuring the ports (see the ShutdownOrder name-value pair of sltest.xil.framework.FrameworkConfiguration).
shutdown	shutdown Shuts down simulations and releases all resources allocated by the framework.
createVariable	testvar = createVariable(testvarname) Creates a TestVariable object that corresponds to a test variable on the test bench. You use createVariable, which specifies the variable name mapped during configuration, in the test body. Calling createVariable in the test body lets you use that test body without changes on other test benches by remapping the variables to variables on the new test bench. The recommended workflow is to create the test variables immediately after calling the init method. Input testVariableName — Name to use for the created test variable, specified as a character vector. The name is one of mapped test variable names. For information about mapping, see the addTestVariableMapping method of sltest.xil.framework.FrameworkConfiguration. Output testvar — The created test variable, returned as an sltest.xil.framework.TestVariable object.
loadConfiguration	loadConfiguration(configfile) Loads an ASAM XIL Framework configuration file into the configuration for the framework. Input configfile — Path to the framework configuration file, specified as a character vector.
waitForSimulationComplete	waitForSimulationComplete tf = waitForSimulationComplete(Timeout=Value) Waits for the simulation to complete. Optionally, specify the Timeout as a double, indicating the number of seconds to wait for the simulation to complete. This method applies only to model access ports. Output tf — If you specify a Timeout, returns true if the simulation completes within the specified timeout, or false if the simulation times out before the simulation completes.
pushDataToSimulinkTestManager	pushDataToSimulinkTestManager(testcase,data) Pushes the logged test case data to the Test Manager as a Simulink.SimulationData.Dataset object, which is the output of the fetch method of sltest.xil.framework.Acquisition. You can use this method only if you are running your code in the Test Manager. Inputs testcase — Name of the test case, specified as a sltest.TestCase object. data — Data logged by the test, obtained by the fetch method, specified as the output variable name from the fetch command.
displayAvailableTestbenches	displayAvailableTestbenches Displays the available ASAM XIL test benches. Use this method before or after creating ports or configurations.
displayAllTestbenchVariables	displayAllTestbenchVariables Displays all the test bench variables for all ports. Before you can use the displayAllTestbenchVariables method, configure your test bench by adding ports, and then call the init method.
displayAllTaskInfo	displayAllTaskInfo Displays the test bench task names for all ports. A task is the rate at which data logging occurs for a test variable. Before you can use the displayAllTaskInfo method, configure your test bench by adding ports, and then call the init method.
getAvailableTestbenches	tbenches = getAvailableTestbenches(tbenchtype) Returns the available ASAM XIL test benches of the specified type. You can use this method before creating ports or configurations. Input tbenchtype — Test bench type, specified as 'asamxil.v2_1'. Output tbenches — Available test benches, returned as a structure with VendorName, ProductName, ProductVersion, and XILVersion fields.
getTestbenchVariableNames	varnames = getTestbenchVariableNames(portname) Returns the test bench variable names for the specified port. Before you can display the variable names, configure your test bench by adding ports, and then call the init method. Input portname — Name of the port for which to return the associated variable names, specified as a character vector. Output varnames — Variable names, returned as a cell array of character vectors.
getTaskNames	taskname = getTaskNames(portname) Returns the test bench task names for the specified port. A task is the rate at which data logging occurs for a test variable. Before you can use the getTaskNames method, configure your test bench by adding ports and then call the init method. Input portname — Name of the port for which to return the associated task names, specified as a character vector. You create the port name using a sltest.xil.framework.FrameworkConfiguration method for the specific type of port. Output taskname — Names of the tasks associated with the specified port, returned as a cell array of character vectors. You define the task names using the addTestVariableMapping method of sltest.xil.framework.FrameworkConfiguration.
getTaskInfo	taskinfo = getTaskInfo(portname) Returns information about the tasks for a given port. A task is the rate at which data logging occurs for a test variable. Before you can use the getTaskInfo method, configure your test bench by adding ports and then call the init method. Input portname — Name of the port for which to return the associated task information, specified as a character vector. Output taskinfo — Information about the tasks, returned as a cell array of structures.

Examples

Display All Test Bench Variables and Tasks

This example shows how to:

• Create a Framework object

• Configure a model access port

• Initialize the framework

• Display the test bench variables and their logging rate (Task) information.

Note

The configuration values in this example are placeholders. To set up the values for your test bench, see Create and Run Tests Using the ASAM XIL Standard.

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;

Retrieve and Plot Logged Simulation Data

This example shows how to:

• Create a Framework object

• Configure a model access port

• Map the Signal test variable to the Model/Integ1/Output1 test bench variable

• Initialize the framework

• Create an instance of the Signal variable

• Set up and start the acquisition, and start and stop the simulation

• Fetch the result data and plot the results

Note

The configuration and variable mapping values in this example are placeholders. To set up the values for your test bench, see Create and Run Tests Using the ASAM XIL Standard.

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;

Version History

Introduced in R2022a