Learn more about Simulink Report Generator

The System Design Description Report

On this page…
What is the Report? What You Can Do with the Report Report Contents Limitations

What is the Report?

The System Design Description report describes a system design represented by a Simulink model. The Simulink Report Generator generates the report from the model.

Back to Top

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 version of the report, using the Report Explorer

Back to Top

Report Contents

You can generate summary and detailed versions of the System Design Description.

Summary Version

Section	Information
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 Look-up tables 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.

Section	Information
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 Block execution order for root system and atomic subsystems Look-up tables State charts Requirements (optional)
Subsystems	Similar information to 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 used to generate the report differs from other versions of the subsystem
State Charts	State chart States Transitions between the states Junctions Events that trigger state transitions Data types Targets

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

Consider adding descriptive information in a model in these ways, to enrich the generated System Design Description.

Back to Top

Limitations

The System Design Description report does not include:

• Referenced models

  • For each referenced model you want a System Design Description, you must generate a separate report.

• Simulink data objects

Back to Top

Generating a System Design Description

Choosing Report Options

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS