Main Content

Create Report Programs Using the Report API

Write MATLAB® programs that generate reports

To create programs that generate reports about Simulink® models and Stateflow® charts, use the Simulink Report Generator™ Report API together with the MATLAB Report Generator Report API and DOM API. The Simulink Report Generator Report API provides classes that you can use to find and format information about Simulink models and Stateflow charts. The MATLAB Report Generator API provides classes that you can use to create and format a title page, table of contents, chapters, and other report elements.

Classes

expand all

slreportgen.finder.AnnotationFinder Find Simulink annotation objects
slreportgen.finder.BlockFinder Find Simulink blocks
slreportgen.finder.BlockResult Create block finder result object
slreportgen.finder.ChartDiagramFinder Create Stateflow chart finder
slreportgen.finder.DataDictionaryFinderFind data dictionaries
slreportgen.finder.DataDictionaryResultData dictionary search result object
slreportgen.finder.DiagramElementFinderCreate diagram element finder object
slreportgen.finder.DiagramElementResult Create diagram element finder result object
slreportgen.finder.DiagramFinder Create finder for diagrams
slreportgen.finder.DiagramResult Create diagram result finder object
slreportgen.finder.ModelVariableFinderFinds variables used by a Simulink model
slreportgen.finder.ModelVariableResultModel variable search result object
slreportgen.finder.StateFinder Find Stateflow states
slreportgen.finder.StateflowDiagramElementFinderFind Stateflow diagram elements
slreportgen.finder.SystemDiagramFinder Create block diagram finder
slreportgen.report.BusObjectSimulink bus object reporter
slreportgen.report.DataDictionarySimulink data dictionary reporter
slreportgen.report.DiagramCreate diagram reporter
slreportgen.report.DocBlock DocBlock reporter
slreportgen.report.ElementDiagram Element diagram snapshot and caption reporter
slreportgen.report.ExecutionOrderSystem task and block execution order reporter
slreportgen.report.LookupTableLookup table block reporter
slreportgen.report.MATLABFunctionMATLAB Function block or Stateflow MATLAB function reporter
slreportgen.report.ModelConfigurationModel configuration set reporter
slreportgen.report.ModelVariableModel variable reporter
slreportgen.report.NotesSimulink or Stateflow diagram notes reporter
slreportgen.report.ReportSuperclass for report creation
slreportgen.report.RptFileCreate Report Explorer-based reporter
slreportgen.report.SimulinkObjectPropertiesSimulink object properties reporter
slreportgen.report.StateflowObjectPropertiesStateflow object properties reporter
slreportgen.report.SystemHierarchySystem hierarchy reporter
slreportgen.report.SystemIOSimulink system input and output signal reporter
slreportgen.report.TestSequenceTest Sequence block reporter
slreportgen.report.TruthTable Truth table reporter

Topics

Create a Simulink Report Generator Report

Use the Report API to create a System Design Description report.

Generate a System Design Report with the Report API

Create a report program to generate a description of the design of a dynamic system.

Report on MATLAB Function

Report on Simulink MATLAB Function block or Stateflow MATLAB function

Reporting on DocBlock Blocks

Use slreportgen.report.DocBlock reporters to include contents of DocBlock blocks in a report.

Report Model Notes

Use an slreportgen.report.Notes reporter to report on model notes.

Create a Simulink Bus Object Report

Create report of bus objects used in a Simulink model.

Report System Inputs and Outputs

Use an slreportgen.report.SystemIO object to report on model and subsystem inputs and outputs.

Report Systems Hierarchically

Create report with model systems numbered hierarchically

Report Execution Order of Tasks and Blocks in a Simulink System

Use an slreportgen.report.ExecutionOrder reporter to report on the tasks executed by a model and the order in which the blocks execute during each task.

Tile Simulink Diagrams

Span a Simulink diagram across multiple pages of a report

Customize Simulink Diagram Hyperlinks in HTML and PDF Reports

Customize hyperlink target for a block

Use Simulink Report Explorer Components in a Report API Report

Use RptFile reporter to add Report Explorer component content to a Report API report.

Related Information