Simulink Report Generator

Understanding a System Design Description Report

This example describes the contents of a System Design Description that the Simulink® Report Generator™ product creates for a model. The report provides details about a system design represented by a Simulink model.

This example shows how to interpret a report called System Design Description. The Simulink Report Generator product creates the report automatically from a Simulink model that you choose. In "Generating a System Design Description Report", you produce the System Design Description for the Simulink example model, sldemo_autotrans. This example describes the contents of that report.

Front Matter

The System Design Description report begins with two sections: title page and table of contents.

The title page lists the title, subtitle, authors, and legal notice that you specify in the System Design Description dialog box. If you specify an image file in the dialog box, that image is on the title page. By default, the title page also displays the date and time that you generated the report.

The table of contents follows the title page. Navigate quickly to particular chapters and sections by clicking items in the table of contents.

Model Version Chapter

The Model Version chapter of the System Design Description provides the following information about the model:

  • Version number for this model.

  • Date and time this model was last saved.

  • Checksum that indicates whether this model differs functionally or cosmetically from other versions of this model.

Root System Chapter

The Root System chapter of the System Design Description provides details about the root (i.e., top-level) system in a Simulink model. The chapter includes the following sections:

Diagram: Simulink block diagram that graphically represents the algorithm that computes the root system outputs.

Description: Description of the root system. This section appears only if the model specifies a value for its Documentation property or the root system contains a Doc block.

Interface: Name, data type, width, and other properties of the root system input and output signals. The number of the block port that outputs the signal appears in angle brackets appended to the signal name. This section appears only if the root system contains Inport or Outport blocks.

Blocks: This section includes the following subsections:

  • Parameters: Describes key parameters of blocks in the root system. This section also includes graphical and tabular representations of table data of blocks that compute their outputs by "lookup" operations, e.g., Lookup Table blocks.

  • Block Execution Order: Order in which blocks must execute at each time step to ensure that each block's inputs are available when the block executes.

State Charts: Describes state charts in the root system. This section appears only if the root system contains Stateflow blocks.

Subsystems Chapter

The Subsystems chapter of the System Design Description provides details about the subsystems in a Simulink model. The chapter includes the following subsections that describe each of the subsystems that a model contains.

Path: The subsystem path in the model. The path indicates the subsystem location in the model hierarchy.

Checksum: This section appears only if the subsystem is atomic. The checksum indicates whether the version of the subsystem differs functionally from other versions of the subsystem. If two checksums differ, the corresponding versions of the subsystems differ functionally.

Diagram: Simulink block diagram that graphically represents the algorithm that computes the subsystem outputs.

Description: Description of the subsystem. This section appears only if the subsystem specifies a value for its Documentation property or contains a Doc block.

Interface: Name, data type, width, and other properties of the subsystem input and output signals. The number of the block port that outputs the signal appears in angle brackets appended to the signal name. This section appears only if the subsystem is atomic and contains Inport or Outport blocks.

Blocks: This section includes the following subsections:

  • Parameters: Describes key parameters of blocks in the subsystem. This section also includes graphical and tabular representations of table data of blocks that compute their outputs by "lookup" operations, e.g., Lookup Table blocks.

  • Block Execution Order: Order in which the subsystem blocks must execute at each time step to ensure that each block's inputs are available when the block executes. This section appears only if the subsystem is atomic.

State Charts: Describes state charts in the subsystem. This section appears only if the subsystem contains Stateflow blocks.

System Design Variables Chapter

The System Design Variables chapter of the System Design Description provides information about MATLAB variables that specify values of block parameters in a Simulink model. The chapter includes a table that lists the following information about each MATLAB variable that the model uses.

  • Variable name

  • Name of block whose parameter uses the variable

  • MATLAB expression involving the variable, specified by a block parameter

  • Size of the variable

  • Class (i.e., data type) of the variable

  • Value of the variable

Back Matter

The System Design Description report ends with two chapters: Glossary and About This Report.

The Glossary chapter defines Simulink terminology that the report uses.

The About This Report chapter provides an overview of the System Design Description and its contents.

Further Information

For more information about the contents of the System Design Description, refer to Report ContentsReport Contents in the Simulink Report Generator user guide documentation.