System Design Documentation and Results Reporting

Types of Reports

Two common user goals for reports are:

You use a very similar workflow for creating and generating both kinds of reports. However, some components are particularly useful for one or the other kind of report.

System Design Documentation

System documentation has many uses, including:

  • Capturing design decisions

  • Recording implementation details

  • Communicating the system design and interfaces among groups

You can view information about a system without creating a report. For more information, see Interactive Model Exploration.

When you create a Simulink® Report Generator™ report to provide system design documentation, the report captures information about the system design directly from the model. Each time that you generate the report, you see up-to-date documentation for the design.

The following table includes some examples of components that are useful for system design documentation reports.

System InformationExamples of Components to Use
RequirementsRequirements Summary Table (for requirements specified with Simulink Verification and Validation™)
System layoutSystem Hierarchy, System Snapshot
Model configurationModel Configuration Set, Model Advisor Report
Block parameter settingsSimulink Dialog Snapshot, Block Loop
PropertiesSimulink Property Table, Simulink Summary Table
VariablesVariable Table, Simulink Workspace Variable
System documentation included in a modelDocumentation, Simulink Name

Results Reporting

Results reporting has many uses, including:

  • Model regression testing

  • Verifying and validating designs

  • Exploring design alternatives

  • Optimizing designs

Simulink provides several tools for examining the results of a simulation. Simulation data includes signal, time, output, state, and data store logging data. You can set up your model to export simulation data to the MATLAB® workspace during simulation for later retrieval, analysis, and postprocessing. You can use several approaches to explore the simulation data. For details, see Export Simulation Data in the Simulink documentation.

You can report on results without creating a report. For more information, see Interactive Model Exploration.

The following table includes some examples of components that are useful results reports.

Results InformationExamples of Components to Use
Signal valuesScope Snapshot, Block Loop
Simulation processingModel Simulation, Model Configuration Set, Fixed-Point Logging Options
Figures generated with MATLABFigure Snapshot, To Workspace Plot
Generated codeCode Generation Summary, Import Generated Code

You can use components such as the Model Simulation component to control how the model simulates. Other components, such as the Scope Snapshot, show the results of the simulation.

Was this topic helpful?