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
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.FunctionReferenceFinderFind MATLAB function references in Simulink blocks
slreportgen.finder.FunctionReferenceResultSearch result object that represents a MATLAB function reference
slreportgen.finder.ModelVariableFinderFinds variables used by a Simulink model
slreportgen.finder.ModelVariableResultModel variable search result object
slreportgen.finder.SignalFinderFind signals used by model or block
slreportgen.finder.SignalResultSignal search result object
slreportgen.finder.StateFinder Find Stateflow states
slreportgen.finder.StateflowDiagramElementFinderFind Stateflow diagram elements
slreportgen.finder.SystemDiagramFinder Create block diagram finder

Superclass for Reporters

slreportgen.report.ReporterSuperclass for Simulink reporters

Model Reporters

slreportgen.report.DataDictionarySimulink data dictionary reporter
slreportgen.report.ExecutionOrderSystem task and block execution order reporter
slreportgen.report.FunctionReferenceReporter for MATLAB function references
slreportgen.report.ModelConfigurationModel configuration set reporter
slreportgen.report.ModelVariableModel variable reporter
slreportgen.report.NotesSimulink or Stateflow diagram notes reporter
slreportgen.report.RptFileCreate Report Explorer-based reporter
slreportgen.report.SystemHierarchySystem hierarchy reporter

Diagram Reporters

slreportgen.report.CCallerC Caller block reporter
slreportgen.report.CFunctionC Function block reporter
slreportgen.report.DiagramCreate diagram reporter
slreportgen.report.DocBlock DocBlock reporter
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.SimulinkObjectPropertiesSimulink object properties reporter
slreportgen.report.StateflowObjectPropertiesStateflow object properties reporter
slreportgen.report.StateTransitionTableState Transition Table Reporter
slreportgen.report.TestSequenceTest Sequence block reporter
slreportgen.report.TruthTable Truth table reporter

Signal Reporters

slreportgen.report.BusReporter for buses selected or created by Simulink blocks
slreportgen.report.BusObjectSimulink bus object reporter
slreportgen.report.SignalSignal reporter
slreportgen.report.SystemIOSimulink system input and output signal reporter

Summary Table Reporter

slreportgen.report.SummaryTable Summary table reporter for finder results

Topics

Related Information