sltest.xil.framework.Acquisition Class

Namespace: sltest.xil.framework

Control signal data logging on test bench and retrieve logged data

Since R2022a

Description

Add-On Required: This feature requires the Simulink Test Support Package for ASAM XIL Standard add-on.

Use the sltest.xil.framework.Acquisition class to set up variables on the test bench to log data, control data acquisition, and retrieve the acquired logged data.

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

Creation

You cannot create an sltest.xil.framework.Acquisition object. An Acquisition object exists only as a member of an sltest.xil.framework.Framework object. Create a Framework object first, and then use the Acquisition methods from within that Framework object.

Methods

Public Methods

setupWithVariables	setupWithVariables(testvar) Configures the sltest.xil.framework.TestVariable object, testvar, to log variables. The TaskName property of each TestVariable input specifies the rate at which data logging occurs (see sltest.xil.framework.FrameworkConfiguration). Use the optional name-value arguments to set up triggering. setupWithVariables automatically creates the acquisition configuration. Input Argument testvar — Variables to set up on the test bench for logging, specified as a single sltest.xil.framework.TestVariable object or an array of TestVariable objects. Name-Value Pair Inputs TriggerVariables — Variables used for triggering, specified as an sltest.xil.framework.TestVariable object or an array of TestVariable objects. The trigger variables do not need to be the same as the variables being logged. StartTriggerType — Type of trigger to start log data acquisition, specified as 'no trigger' (default) or 'condition'. If you specify 'no trigger', acquisition starts immediately on the test bench. For your test bench, acquisition might start when start or Framework.start is called, depending on your test bench hardware. (Refer to the documentation for your specific test bench hardware.) When you specify 'condition', acquisition begins when the condition is met. StartTriggerVal — Value of the trigger to start log data acquisition, specified as a character array expression. This input applies only when StartTriggerType is 'condition'. StartTriggerTimeout — Time, in seconds, on the test bench to start log data acquisition if StartTriggerType is 'condition' and the condition does not occur. Specify StartTriggerTimeout as a double. StopTriggerType — Type of trigger to stop log data acquisition, specified as 'no trigger' (default), 'condition', or 'duration'. If you specify 'no trigger', acquisition continues until simulation stops. If you specify 'condition', acquisition continues until the stop condition is met. If you specify 'duration', acquisition ends at the specified duration after acquisition began. StopTriggerVal — Value of the trigger that stops log data acquisition, specified as a character array expression when StopTriggerType is 'condition', or as a double when StopTriggerType is 'duration'. StopTriggerTimeout — Time, in seconds, on the test bench to stop log data acquisition if StartTriggerType is 'condition' and the condition does not occur. After this timeout, the test bench proceeds to the next trigger state. SpecifyStopTriggerTimeout as a double.
start	start Enables data logging based on settings and triggering you specified with the setupWithVariables method. On most hardware platforms, triggering and data logging begins when you call framework.start. On some platforms, triggering and data logging begins immediately when you call this Acquisition.start method.
stop	stop Stops log data acquisition immediately, even if triggering has not completed.
wait	wait wait(Name=Value) Waits for triggering to complete. When triggering completes, data acquisition stops. Then, you can use fetch to obtain the logged data. Name-Value Pair Timeout — Time on the host, in seconds, to wait for triggering to complete, specified as a double. If you specify a timeout, wait returns false if the timeout ends before the test bench completes the acquisition, or true if the acquisition is complete.
fetch	data = fetch Stops log data acquisition immediately and returns a Simulink.SimulationData.Dataset object, even if triggering has not completed.
clearConfiguration	clearConfiguration clears the current acquisition configuration.

Examples

Set Up Acquisition Without Triggering

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.Configuration.addTestVariableMapping(...
    'Throttle','MAPort1','simpleXIL/Gain/Gain');

frm.init;

rpm = frm.createVariable('RPM');
throttle = frm.createVariable('Throttle');

frm.Acquisition.setupWithVariables([throttle,rpm]);
frm.Acquisition.start;

frm.start;

Set Up Acquisition with Triggering

To change the above example to use triggering, change the setupWithVariables method to specify the trigger variable, the start and stop trigger types, and start and stop trigger values.

frm.Acquisition.setupWithVariables([throttle,rpm],...
   TriggerVariables=rpm,...
   StartTriggerType='condition',StartTriggerVal='rpm > 500',...
   StopTriggerType='duration',StopTriggerVal=3);

Version History

Introduced in R2022a