This example shows you how to use Simulink® Report Generator™ to create a System Design Description report for a model. The report provides summary or detailed information about a system design represented by a Simulink model.
This example shows you how to generate a report called System Design Description. The Simulink Report Generator product creates the report automatically from a Simulink model that you choose. It populates the report with content from the Simulink model. You can customize the report by altering aspects of the Simulink model.
You can customize the Simulink example model,
sldemo_autotrans, which represents an automotive drivetrain. To open the example model, run the following command:
By default, the System Design Description report includes the text specified by the
Description property associated with models and blocks. Use this property to add custom documentation to a report.
The Simulink example model,
sldemo_autotrans, already specifies text in its
Description property. To access this property, from the model File menu, select Model Properties. In the Model Properties dialog box, select the Description tab.
When you generate the System Design Description for this model, the report captures the text and includes it in the Root System chapter.
Similarly, you can specify text for the
Description property associated with individual Subsystem blocks in a model. For example, in
sldemo_autotrans, right-click the Engine block and from the context menu, select Properties. In the Block Properties dialog box, for the Description property, specify the following text:
The Engine subsystem consists of a two-dimensional lookup table that interpolates engine torque versus throttle and engine speed.
After you apply the change and regenerate the System Design Description for this model, the report captures the text and includes it in the Subsystems chapter.
By default, the System Design Description report includes the text within a DocBlock. Use these blocks in the model hierarchy to add custom documentation to a report.
For example, in
sldemo_autotrans, double-click the Engine subsystem to view its contents. From the Simulink Library Browser, drag a DocBlock (under the Model-Wide Utilities library) to the Engine subsystem.
Double-click the DocBlock and in the editor, specify the following text:
The TorqueConverter and the TransmissionRatio blocks make up the Transmission subsystem. The TorqueConverter is a masked subsystem that requires a vector of speed ratios (Nin/Ne) and vectors of K-factor (f2) and torque ratio (f3). The TransmissionRatio block determines the gear ratio and computes the transmission output torque and input speed.
After you save the text and regenerate the System Design Description for this model, the report captures your documentation and includes it in the Subsystems chapter.
By default, the System Design Description report lists requirement links that you establish between requirements documents and Simulink or Stateflow objects. You create requirement links using the Simulink Verification and Validation software, for which you need a product license.
For example, assume that requirements for the
sldemo_autotrans model are in a Microsoft® Word document.
Suppose that you link the Engine requirement in that document to the Engine subsystem in the
sldemo_autotrans model. If you generate the System Design Description for this model, the report captures the requirement link in a Requirements Traceability chapter. The chapter displays tables that provide requirement descriptions and hyperlinks to associated documents, enabling you to navigate easily to particular requirements.
For more information about the
Description property associated with models, see Model Properties Dialog Box in the Simulink user guide. To learn more about the DocBlock, see its reference page in the Simulink documentation. For more information about linking requirements to model components, refer to Links Between Models and Requirements in the Simulink Verification and Validation documentation.