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.report.ReportReport container

Creation Finders

slreportgen.finder.BlockResult Create block finder result object
slreportgen.finder.ChartDiagramFinder Create Stateflow chart finder
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.StateflowObjectResult Create Stateflow result object (Since R2023a)
slreportgen.finder.SystemDiagramFinder Create block diagram finder

Search Finders

slreportgen.finder.AnnotationFinder Find Simulink annotation objects
slreportgen.finder.BlockFinder Find Simulink blocks
slreportgen.finder.DataDictionaryFinderFind data dictionaries (Since R2020b)
slreportgen.finder.EnumerationTypeFinderFind enumerated data types used in Simulink model (Since R2023b)
slreportgen.finder.ModelVariableFinderFinds variables used by a Simulink model (Since R2019b)
slreportgen.finder.SignalFinderFind signals used by model or block (Since R2021a)
slreportgen.finder.StateFinder Find Stateflow states
slreportgen.finder.StateflowDiagramElementFinderFind Stateflow diagram elements
slreportgen.finder.StateflowObjectFinderFind Stateflow objects (Since R2023a)

Search Result Finders

slreportgen.finder.DataDictionaryResultData dictionary search result object (Since R2020b)
slreportgen.finder.EnumerationTypeResultSearch results for enumeration types found within Simulink model or subsystem (Since R2023b)
slreportgen.finder.FunctionReferenceResultSearch result object that represents a MATLAB function reference (Since R2022a)
slreportgen.finder.ModelVariableResultModel variable search result object (Since R2019b)
slreportgen.finder.SignalResultSignal search result object (Since R2021a)

Superclass for Reporters

slreportgen.report.ReporterSuperclass for Simulink reporters (Since R2021a)

Model Reporters

slreportgen.report.DataDictionarySimulink data dictionary reporter (Since R2020b)
slreportgen.report.EnumerationTypeSimulink enumerated data type reporter (Since R2023b)
slreportgen.report.ExecutionOrderSystem task and block execution order reporter (Since R2020b)
slreportgen.report.FunctionReferenceReporter for MATLAB function references (Since R2022a)
slreportgen.report.ModelConfigurationModel configuration set reporter (Since R2020b)
slreportgen.report.ModelVariableModel variable reporter (Since R2019b)
slreportgen.report.NotesSimulink or Stateflow diagram notes reporter (Since R2020a)
slreportgen.report.RptFileCreate Report Explorer-based reporter (Since R2019a)
slreportgen.report.SystemHierarchySystem hierarchy reporter (Since R2019b)

Diagram Reporters

slreportgen.report.AnnotationReport on Simulink annotations (Since R2022b)
slreportgen.report.CCallerC Caller block reporter (Since R2022a)
slreportgen.report.CFunctionC Function block reporter (Since R2021b)
slreportgen.report.DiagramCreate diagram reporter
slreportgen.report.DocBlock DocBlock reporter (Since R2019b)
slreportgen.report.ElementDiagram Element diagram snapshot and caption reporter
slreportgen.report.LookupTableLookup table block reporter
slreportgen.report.MATLABFunctionMATLAB Function block or Stateflow MATLAB function reporter
slreportgen.report.MATLABSystemMATLAB System block reporter (Since R2023a)
slreportgen.report.SimulinkObjectPropertiesSimulink object properties reporter
slreportgen.report.StateflowObjectPropertiesStateflow object properties reporter
slreportgen.report.StateTransitionTableState Transition Table Reporter (Since R2022a)
slreportgen.report.TestSequenceTest Sequence block reporter (Since R2020b)
slreportgen.report.TruthTable Truth table reporter

Signal Reporters

slreportgen.report.BusReporter for buses selected or created by Simulink blocks (Since R2021a)
slreportgen.report.BusObjectSimulink bus object reporter (Since R2019b)
slreportgen.report.SignalSignal reporter (Since R2021a)
slreportgen.report.SystemIOSimulink system input and output signal reporter (Since R2020a)

Summary Table Reporter

slreportgen.report.SummaryTable Summary table reporter for finder results (Since R2022a)

Topics

Related Information