System Design Description

Predefined Standard Reports

From the Simulink® Editor, you can access two predefined, standard Simulink Report Generator™ reports called:

  • System Design Description

  • System Requirements Traceability

The System Design Description report provides summary or detailed information about a system design represented by a model. You can choose report options using the report dialog, or you can create a customized version using the Report Explorer. For details, see Generate a System Design Description.

You can use the System Design Description report setup file as a starting point for creating a setup file for your own report.

You can also generate an HTML model report for Stateflow® charts. For details, see Generate a Model Report.

The System Requirements Traceability report requires that you have the Simulink Verification and Validation™ product installed. The System Requirements Traceability report includes information about all the requirements associated with the model and its objects. For details, see Customize Requirements Traceability Report for Model in the Simulink Verification and Validation documentation.

What Is the System Design Description?

The System Design Description is a prebuilt Simulink Report Generator report that describes the system design represented by a Simulink model.

By default, the Simulink Report Generator generates the report for the model from which you invoke the System Design Description report option.

What You Can Do with the Report

You can use the System Design Description to

  • Review a system design without having the model open

  • Generate summary and detailed descriptions of the design

  • Assess compliance with design requirements

  • Archive the system design in a format independent of the modeling environment

  • Build a customized version of the report, using the Report Explorer

Report Contents

You can specify what kinds of information to include in the report, in terms of:

  • What elements of a model to include in the report (for example, whether to include subsystems from custom libraries)

  • Whether to generate a summary version or a detailed version of the System Design Description report.

For details, see Generate a System Design Description.

Summary Version

SectionInformation
Report Overview

Model version

Root System
  • Block diagram representing the algorithms that compute root system outputs

  • Description (if available from model)

  • Interface: name, data type, and other properties of the system input and output signals

  • Subsystems: the path and a block diagram for each subsystem

  • State charts

  • Requirements (optional)

Subsystems
  • Path

  • Block diagram

System Design Variables
  • Design variables

  • Functions in design variable expressions

Detailed Version

The detailed version of the report includes all the information that is in the summary form of the report, as well as more information about the system components. The atomic subsystem information is more detailed than virtual subsystem information.

SectionInformation
Report Overview

Model version

Root system
  • Block diagram representing the algorithms that compute root system outputs

  • Description (if available from model)

  • Interface: name, data type, and other properties of the root system input and output signals

  • Block parameters

    • Includes detailed information about MATLAB Function blocks

  • Block execution order for root system and atomic subsystems

  • Look-up tables

  • Simulink workspace variables

  • Model configuration sets

  • State charts

  • Requirements (optional)

Subsystems

The same type of information as the information for the root system, as well as:

  • Path of the subsystem in the model

  • (For atomic subsystems) Checksum that indicates whether the version of an atomic subsystem that generates the report differs from other versions of the subsystem

  • Referenced models (optional)

  • Subsystems from custom libraries (optional)

State Charts
  • State chart

  • States

  • Transitions between the states

  • Junctions

  • Events that trigger state transitions

  • Data types

  • Targets

  • Truth tables

Report Captures Documentation Included in a Model

The System Design Description reports documentation included in a model, including:

  • The model description (from the model properties)

  • The block property Description

  • DocBlock model documentation blocks

To enrich the generated System Design Description, consider adding descriptive information in a model in these ways listed above.

Was this topic helpful?