|On this page…|
Two common user goals for reports are:
System design documentation — Capture information about the design decisions, structure, implementation, and operational details of a system.
Results reporting — Present results of running a system.
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 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 Information||Examples of Components to Use|
|Requirements||Requirements Summary Table (for requirements specified with Simulink Verification and Validation™)|
|System layout||System Hierarchy, System Snapshot|
|Model configuration||Model Configuration Set, Model Advisor Report|
|Block parameter settings||Simulink Dialog Snapshot, Block Loop|
|Properties||Simulink Property Table, Simulink Summary Table|
|Variables||Variable Table, Simulink Workspace Variable|
|System documentation included in a model||Documentation, Simulink Name|
Results reporting has many uses, including:
Model regression testing
Verifying and validating designs
Exploring design alternatives
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 Information||Examples of Components to Use|
|Signal values||Scope Snapshot, Block Loop|
|Simulation processing||Model Simulation, Model Configuration Set, Fixed-Point Logging Options|
|Figures generated with MATLAB||Figure Snapshot, To Workspace Plot|
|Generated code||Code 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.