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

Report Container

slreportgen.report.Report Report container

Finders

`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.DataDictionaryFinder`	Find data dictionaries
`slreportgen.finder.DataDictionaryResult`	Data dictionary search result object
`slreportgen.finder.DiagramElementFinder`	Create 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.FunctionReferenceFinder`	Find MATLAB function references in Simulink blocks
`slreportgen.finder.FunctionReferenceResult`	Search result object that represents a MATLAB function reference
`slreportgen.finder.ModelVariableFinder`	Finds variables used by a Simulink model
`slreportgen.finder.ModelVariableResult`	Model variable search result object
`slreportgen.finder.SignalFinder`	Find signals used by model or block
`slreportgen.finder.SignalResult`	Signal search result object
`slreportgen.finder.StateFinder`	Find Stateflow states
`slreportgen.finder.StateflowDiagramElementFinder`	Find Stateflow diagram elements
`slreportgen.finder.StateflowObjectFinder`	Find Stateflow objects
`slreportgen.finder.StateflowObjectResult`	Create Stateflow result object
`slreportgen.finder.SystemDiagramFinder`	Create block diagram finder

Reporters

Superclass for Reporters

slreportgen.report.Reporter Superclass for Simulink reporters

Model Reporters

`slreportgen.report.DataDictionary`	Simulink data dictionary reporter
`slreportgen.report.ExecutionOrder`	System task and block execution order reporter
`slreportgen.report.FunctionReference`	Reporter for MATLAB function references
`slreportgen.report.ModelConfiguration`	Model configuration set reporter
`slreportgen.report.ModelVariable`	Model variable reporter
`slreportgen.report.Notes`	Simulink or Stateflow diagram notes reporter
`slreportgen.report.RptFile`	Create Report Explorer-based reporter
`slreportgen.report.SystemHierarchy`	System hierarchy reporter

Diagram Reporters

`slreportgen.report.Annotation`	Report on Simulink annotations
`slreportgen.report.CCaller`	C Caller block reporter
`slreportgen.report.CFunction`	C Function block reporter
`slreportgen.report.Diagram`	Create diagram reporter
`slreportgen.report.DocBlock`	`DocBlock` reporter
`slreportgen.report.ElementDiagram`	Element diagram snapshot and caption reporter
`slreportgen.report.LookupTable`	Lookup table block reporter
`slreportgen.report.MATLABFunction`	MATLAB Function block or Stateflow MATLAB function reporter
`slreportgen.report.MATLABSystem`	MATLAB System block reporter
`slreportgen.report.SimulinkObjectProperties`	Simulink object properties reporter
`slreportgen.report.StateflowObjectProperties`	Stateflow object properties reporter
`slreportgen.report.StateTransitionTable`	State Transition Table Reporter
`slreportgen.report.TestSequence`	Test Sequence block reporter
`slreportgen.report.TruthTable`	Truth table reporter

Signal Reporters

`slreportgen.report.Bus`	Reporter for buses selected or created by Simulink blocks
`slreportgen.report.BusObject`	Simulink bus object reporter
`slreportgen.report.Signal`	Signal reporter
`slreportgen.report.SystemIO`	Simulink system input and output signal reporter

Summary Table Reporter

slreportgen.report.SummaryTable Summary table reporter for finder results

Topics

Create Simulink Report Generator Reports
Use the Report API to create System Design Description reports.
Generate System Design Reports with Report API
Create a report program to generate a description of the design of a dynamic system.
Report on MATLAB Functions
Report on Simulink MATLAB Function blocks or Stateflow MATLAB functions.
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 Simulink Bus Object Reports
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 Simulink Systems
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 Report API Reports
Use RptFile reporter to add Report Explorer component content to a Report API report.

Related Information

Report Generator Creation