Documentation

Simulink Report Generator Report Generator Components

Interactive Report Creation

Create Reports

Report Setup

Nest Setup File Allow one report setup file (rpt file) to run inside another
Evaluate MATLAB Expression Evaluate specified MATLAB expression
Comment Insert comment into XML source file created by report generation process

Report Structure Components

Title Page Insert title page at beginning of report
Chapter/Subsection Group portions of report into sections with titles
Paragraph Insert paragraph text into report
Text Format and insert text into report
List Create bulleted or numbered list from cell array or child components
Table Insert parent of table
Array-Based Table Convert rectangular array into table and insert it into report
Variable Table Insert table that displays all the variables in the MATLAB workspace
Image Insert image from external file into report
Link Insert linking anchors or pointers into report
Handle Graphics Linking Anchor Designate location to which links point
Insert Variable Insert variable values into report
Figure Snapshot Insert snapshot of Handle Graphics figure into report
Axes Snapshot Insert image of selected MATLAB axes objects into the generated report
Handle Graphics Name Insert name of Handle Graphics object into the report
Handle Graphics Parameter Insert property name/property value pair from Handle Graphics figure, axes, or other object
MATLAB/Toolbox Version Number Insert table that shows version and release numbers and release date of MathWorks products
Nest Setup File Allow one report setup file (rpt file) to run inside another
Empty Component Group components to move, activate, or deactivate them, or create blank space in list
Import File Import ASCII text file into report

Table Formatting Components

Table Insert parent of table
Table Body Insert parent of table body
Table Column Specification Specify table column properties
Table Entry Insert table entry
Table Footer Insert parent of table footer
Table Header Insert parent of table header
Table Row Insert parent of table row entries

System-Based Information Components

Simulink Model
Simulink Name Insert name of a Simulink model, system, block, or signal into report
Simulink Summary Table Properties or parameters of specified Simulink models, systems, blocks, or signals in table
Simulink Automatic Table Insert two-column table with information on selected model, system, signal, or block
System Hierarchy Create nested list that shows hierarchy of specified system
System Snapshot Insert snapshot of the current system into report
System Filter Run child components if current system meets specified conditions
System Loop Specify systems and subsystems on which to loop, as defined by parent component
Model Loop Loop on Simulink models and systems, as specified by child components
Annotation Loop Run child components multiple times for each Simulink annotation in current context
Model Configuration Set Insert active configuration set of a model into a report
Simulink Sample Time Insert title of Simulink sample time into report
Model Advisor Report Insert Model Advisor report or link to Model Advisor report for current model
Simulink Linking Anchor Designate locations to which links point
Simulink Library Information Insert table that lists library links in the current model, system, or block
Model Change Log Construct model history table that displays model revision information
Block Type Count Count number of each block type in the current model or system
Block Loop Run child components for each block in the current system, model, or signal
Block Execution Order List Create a list or table of all nonvirtual blocks in the model, showing order in which they execute
Scope Snapshot Insert images of scopes and XY graphs
Signal Loop Run child components for each signal contained in current system, model, or block
Bus Create list of signals exiting from Bus Selector block
Documentation Insert text extracted from DocBlock blocks in Simulink models
Look-Up Table Report on lookup table blocks
MATLAB Function Insert information about MATLAB Function block contents
Simulink Dialog Snapshot Insert snapshots of Simulink editor dialog boxes
Variable Table Insert table that displays all the variables in the MATLAB workspace
Insert Variable Insert variable values into report
Simulink Workspace Variable Report on workspace variables used in model, in loop generated by Simulink Workspace Variable Loop component
Simulink Workspace Variable Loop Generates a model variable loop
Simulink Functions and Variables Create table that displays workspace variables and MATLAB functions used by reported blocks in Simulink models
To Workspace Plot Capture plot figure created in the MATLAB workspace
Simulink Property Table Insert table that reports on model-level property name/property value pairs
Simulink Property Insert property name/property value pair for current Simulink model, system, block, or signal
Graphics Object Loop Run child components for each Handle Graphics object open in MATLAB workspace
Figure Loop Apply child components to specified graphics figures
Axes Loop Run child components for all axes objects in MATLAB workspace
Fixed-Point Data
Fixed Point Summary Table Table of specified fixed-point block properties or parameters
Fixed Point Block Loop Run child components for the Simulink model, system, or signal defined by parent component
Fixed Point Property Table Insert table that reports on Fixed-Point Designer block property name/property value pairs
Fixed Point Logging Options Set fixed-point options like in Fixed Point Tool
Stateflow Charts
Stateflow Hierarchy Provide visual representation of the hierarchy of a Stateflow object
Stateflow Hierarchy Loop Run child components on Stateflow object hierarchy
Stateflow Name Insert into report name of Stateflow object specified by parent component
Chart Loop Run child components for specified Stateflow charts
Machine Loop Run child components for specified Stateflow machines
Object Loop Run child components for Stateflow objects, and then insert table into report
State Loop Run child components for all states in current context
State Transition Matrix Insets state transition matrix contents into report
State Transition Table Insets state transition tables into report
Stateflow Automatic Table Insert table with properties of current Stateflow object
Stateflow Count Count number of Stateflow objects in current context
Stateflow Dialog Snapshot Insert snapshots of Stateflow editor dialog boxes
Stateflow Filter Run child components only if current object type matches specified object type
Stateflow Linking Anchor Designate locations to which links point
Stateflow Property Insert into report table, text, or paragraph with information on selected Stateflow object property
Stateflow Property Table Insert into report property-value table for Stateflow object
Stateflow Snapshot Insert into report snapshot of Stateflow object
Stateflow Summary Table Table of properties or parameters of specified Stateflow object
Truth Table Report on truth tables in Simulink and Stateflow models
Simulink Function System Loop Report on Simulink functions specified in a Stateflow loop
Code Generation
Code Generation Summary Insert version number information, list of generated files, tables summarizing code generation configuration information, and subsystem maps into report
Import Generated Code Import source and header files generated by Simulink Coder software, and custom files specified as part of model
Code Verification
Acronym Definitions Create table of Polyspace acronyms used in report and their full forms
Call Hierarchy Create table showing call graph in source code
Code Metrics Details Create table of Polyspace metrics broken down by file and function
Code Metrics Summary Create table of Polyspace metrics
Code Verification Summary Create table of Polyspace analysis results
Code and Verification Information Create table of verification times and code characteristics
Coding Rules Details Create table of coding rule violations broken down by file
Coding Rules Summary Create table with number of coding rule violations
Configuration Parameters Create table of analysis options and coding rules
Defects Summary Create table of Polyspace Bug Finder defects
Recursive Functions Create table of recursive functions
Report Customization (Filtering) Create filters that apply to your Polyspace reports
Run-time Checks Details Ordered by Color/File Create overrides for global filters in Polyspace reports
Run-time Checks Details Ordered by Review Information Create table with Polyspace Code Prover checks ordered by review information
Run-time Checks Summary Ordered by File Create table with Polyspace Code Prover checks ordered by file
Software Quality Objectives - Coding Rules Summary Create table of coding rule violations in results downloaded from Polyspace Metrics
Software Quality Objectives - Run-time Checks Details Create table of run-time checks in results downloaded from Polyspace Metrics
Software Quality Objectives - Run-time Checks Summary Create table of run-time check distribution in results downloaded from Polyspace Metrics
Variable Access Create table showing global variable access in source code
Requirements Management Interface
Requirements Documents Table Insert table of linked requirements documents
Requirements System Loop Apply child components to systems with requirements
Requirements Table Requirements links for current context
Requirements Block Loop Apply child components to blocks with requirements
Requirements Summary Table Properties of blocks, systems, or Stateflow objects with associated requirements
Requirements Signal Loop Apply all child components to signal groups with requirements
Missing Requirements Block Loop Apply all child components to blocks that do not have requirements
Missing Requirements System Loop Loop only on systems and subsystems that do not have associated requirements

Dynamic Reporting Components

For Loop Iteratively execute child components
While Loop Iteratively execute child components while a specified condition is true
Logical If Specify logical if condition
Logical Then Specify a then condition for a Logical If component
Logical Else Specify an else condition for a Logical If component
Logical Elseif Specify an elseif condition for a Logical If component
Figure Loop Apply child components to specified graphics figures
Block Loop Run child components for each block in the current system, model, or signal
System Filter Run child components if current system meets specified conditions
Chart Loop Run child components for specified Stateflow charts
Graphics Object Loop Run child components for each Handle Graphics object open in MATLAB workspace
Figure Loop Apply child components to specified graphics figures
Axes Loop Run child components for all axes objects in MATLAB workspace

Format Reports

Table Insert parent of table
Simulink Property Table Insert table that reports on model-level property name/property value pairs
Simulink Summary Table Properties or parameters of specified Simulink models, systems, blocks, or signals in table

Generate Reports

Stop Report Generation Halt report generation
Time/Date Stamp Insert time and date of report generation into report
Model Simulation Run current model with specified simulation parameters
Evaluate MATLAB Expression Evaluate specified MATLAB expression
Comment Insert comment into XML source file created by report generation process
Was this topic helpful?