Simulink Report API Classes

The Simulink Report API provides these finder, result, and reporter classes. To use these classes in a report generator program, you must create a container of type slreportgen.report.Report to hold the report.

Find and Report on Blocks in a Model

This example shows how to find and report on all Simulink blocks in the vdp model using the BlockFinder class. The resulting HTML report includes default information and uses default formatting for each block.

Import the Report API package, which let you use class names without including their package names. For example, you can use BlockFinder instead of slreportgen.finder.BlockFinder. In addition to importing the Simulink Report API base classes, import the MATLAB Report API base class. A typical report includes a title page, table of contents, chapters, and sections, which you include as reporter classes in the MATLAB Report API.

import slreportgen.finder.*
import slreportgen.report.*
import mlreportgen.report.*

Load the vdp model.

model_name = "vdp";
load_system(model_name)

Create the container object to hold the report and open the report. In this case, the output report is saved in zipped vdp_model.htmx HTML report. You can use any output name you want. If you run the report generator more than once using the same output file name, the output file is overwritten. To use Simulink Report API finders and reporters in your report generator program, you must use the fully qualified name to create the container object.

rpt = slreportgen.report.Report('vdp_model','html');
open(rpt)

Add a chapter and specify its title.

ch = Chapter("Blocks in vdp model");

Use the BlockFinder class to create a finder. In this case, the BlockFinder finds all the blocks in the model. Use the find method to find the blocks specified by the finder.

finder = BlockFinder(model_name); 
results = find(finder);

Loop through the results of the find method and create a section for each block, and add the block property table to the section. Then, add each section to the chapter. After all blocks have been added, add the chapter to the report.

for result = results
     sect = Section('Title',result.Name);
     append(sect,result)
     append(ch,sect)
end
append(rpt,ch);

Close the report and model, and view the report.

close(rpt);
close_system(model_name);
rptview(rpt);

Use Specific Finders and Reporters for Different Block Types

Create a PDF report generator that finds all blocks in the slrgex_radar_eml model.

To find all blocks, use the BlockFinder. The if statement shows how to test for MATLAB Function blocks. Use the MATLABFunction reporter to report MATLAB Function block details. The else statement shows how blocks other than MATLAB Function blocks use the BlockFinder find method results.

import slreportgen.report.*
import slreportgen.finder.*
import mlreportgen.report.*

model_name = 'slrgex_radar_eml';
load_system(model_name)

rpt = slreportgen.report.Report('radar','pdf');
open(rpt)

blkfinder = BlockFinder(model_name);
blks = find(blkfinder);
ch = Chapter('Blocks in slrgex_radar_eml Model');

for i=1:length(blks)
   if slreportgen.utils.isMATLABFunction(blks(i).Object)
      rptr = MATLABFunction(blks(i).Object);
      sec = Section(blks(i).Name);
      append(sec,rptr)
      append(ch,sec)
   else
      sec = Section(blks(i).Name);
      append(sec,blks(i)) 
      append(ch,sec)
   end
end
append(rpt,ch)

close(rpt)
close_system(model_name)
rptview(rpt)

An example of the information reported for a MATLAB Function block by the MATLABFunction reporter is:

An example of the information reported by the find method of the BlockFinder is:

Find and Report on Stateflow Elements

This example describes how to find and report on Stateflow states, transitions, and junctions. It reports on the control_logic chart of the slrgex_fuelsys_fuel_rate_control model.

First, set up the report.

import mlreportgen.report.*
import slreportgen.report.*
import slreportgen.finder.*

model_name = "slrgex_fuelsys_fuel_rate_control";
load_system(model_name);
subsys = "slrgex_fuelsys_fuel_rate_control/control_logic";

rpt = slreportgen.report.Report("output","pdf");
open(rpt)

tp = TitlePage("Title",...
   "Control Logic Chart of slrgex_fuelsys_fuel_rate_control");
append(rpt,tp)
append(rpt,TableOfContents);

Next, use a StateFinder object and its find method to find and report on states in the chart. Loop through the array of found states and add each one to the chapter.

chapter = Chapter("Title","States");
stFinder = StateFinder(subsys);
states = find(stFinder);
for state = states
   append(chapter,state)
end
append(rpt,chapter)

To report on the transitions, use a StateflowDiagramElementFinder object and its find method. To show the property table with a narrower width than the default, customize the output. First, obtain the reporter for the result. To set the width, use the TableWidth property of the reporter.

chapter = Chapter("Title","Transitions");
trFinder = StateflowDiagramElementFinder...
   ("Container",subsys,"Types","transition");
transitions = find(trFinder);
for transition = transitions
   rptr = transition.getReporter;
   rptr.PropertyTable.TableWidth = "3in"; 
   append(chapter,rptr)
end
append(rpt,chapter)

Close the report and model, and view the report.

close(rpt)
close_system(model_name)
rptview(rpt)