Real-Time Workshop Pane: Report :: Configuration Parameters (Real-Time Workshop®)

Real-Time Workshop^®

Real-Time Workshop Pane: Report

On this page…
Report Tab Overview Create code generation report Launch report automatically Code-to-model Model-to-code Configure Eliminated / virtual blocks Traceable Simulink blocks Traceable Stateflow objects Traceable Embedded MATLAB functions

On this page…

Report Tab Overview

Create code generation report

Launch report automatically

Code-to-model

Model-to-code

Configure

Eliminated / virtual blocks

Traceable Simulink blocks

Traceable Stateflow objects

Traceable Embedded MATLAB functions

Report Tab Overview

Control the Code Generation report that the Real-Time Workshop software automatically creates.

Configuration

To create a Code Generation report during the build process, select the Create code generation report parameter.

Create code generation report

Document generated code in an HTML report.

Settings

Default: Off

On

Generates a summary of code generation source files in an HTML report. Places the report files in an html subdirectory within the build directory. In the report,

The Summary section lists version and date information. The Configuration Settings at the Time of Code Generation link opens a noneditable view of the Configuration Parameters dialog that shows the Simulink model settings, including TLC options, at the time of code generation.
The Subsystem Report section contains information on nonvirtual subsystems in the model.
The Code Interface Report section provides information about the generated code interface, including model entry point functions and input/output data (requires a Real-Time Workshop Embedded Coder license and the ERT target).
The Traceability Report section allows you to account for Eliminated / Virtual Blocks that are untraceable, versus the listed Traceable Simulink Blocks / Stateflow Objects / Embedded MATLAB Scripts, providing a complete mapping between model elements and code (requires a Real-Time Workshop Embedded Coder license and the ERT target).

In the Generated Source Files section of the Contents pane, you can click the names of source code files generated from your model to view their contents in a MATLAB Web browser window. In the displayed source code,

Global variable instances are hyperlinked to their definitions.

If you selected the traceability option Code-to-model, hyperlinks within the displayed source code let you view the blocks or subsystems from which the code was generated. Click on the hyperlinks to view the relevant blocks or subsystems in a Simulink model window (requires a Real-Time Workshop Embedded Coder license and the ERT target).

If you selected the traceability option Model-to-code, you can view the generated code for any block in the model. To highlight a block's generated code in the HTML report, right-click the block and select Real-Time Workshop > Navigate to Code (requires a Real-Time Workshop Embedded Coder license and the ERT target).

Off

Does not generate a summary of files.

Dependency

This parameter enables and selects

Launch report automatically

Code-to-model (ERT target)

This parameter enables

Model-to-code (ERT target)
Eliminated / virtual blocks (ERT target)
Traceable Simulink blocks (ERT target)
Traceable Stateflow objects (ERT target)
Traceable Embedded MATLAB functions (ERT target)

Command-Line Information

Parameter: GenerateReport

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Launch report automatically

Specify whether to display Code Generation reports automatically.

Settings

Default: Off

On: Displays the Code Generation report automatically in a new browser window.
Off: Does not display the Code Generation report, but the report is still available in the html directory.

Dependency

This parameter is enabled and selected by Create code generation report.

Command-Line Information

Parameter: LaunchReport

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	No impact

Code-to-model

Include hyperlinks in a Code Generation report that link code to the corresponding Simulink blocks, Stateflow objects, and Embedded MATLAB functions in the model diagram.

Settings

Default: Off

On: Includes hyperlinks in the Code Generation report that link code to corresponding Simulink blocks, Stateflow objects, and Embedded MATLAB functions in the model diagram. The hyperlinks provide traceability for validating generated code against the source model.
Off: Omits hyperlinks from the generated report.

Tip

Clear this parameter to speed up code generation. For large models (containing over 1000 blocks), generation of hyperlinks can be time consuming.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled and selected by Create code generation report.
You must select Include comments on the Real-Time Workshop > Comments tab to use this parameter.

Command-Line Information

Parameter: IncludeHyperlinkInReport

Type: string

Value: 'on' | 'off

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Model-to-code

Links Simulink blocks, Stateflow objects, and Embedded MATLAB functions in a model diagram to corresponding code segments in a generated HTML report so that the generated code for a block can be highlighted on request.

Settings

Default: Off

On: Includes model-to-code highlighting support in the Code Generation report. To highlight the generated code for a Simulink block, Stateflow object, or Embedded MATLAB script in the Code Generation report, right-click the item and select Real-Time Workshop > Navigate to Code.
Off: Omits model-to-code highlighting support from the generated report.

Tip

Clear this parameter to speed up code generation. For large models (containing over 1000 blocks), generation of model-to-code highlighting support can be time consuming.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled when you select Create code generation report.
This parameter selects:
You must select the following parameters to use this parameter:
- Include comments on the Real-Time Workshop > Comments tab
- At least one of the following:

Command-Line Information

Parameter: GenerateTraceInfo

Type: Boolean

Value: on | off

Default: off

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Configure

Use the Configure button to open the Model-to-code navigation dialog box. This dialog box provides a way for you to specify a build directory containing previously-generated model code to highlight. Applying your build directory selection will attempt to load traceability information from the earlier build, for which Model-to-code must have been selected.

Dependency

This parameter only appears for ERT-based targets.
This parameter is enabled by Model-to-code.

Eliminated / virtual blocks

Include summary of eliminated and virtual blocks in Code Generation report.

Settings

Default: Off

On: Includes a summary of eliminated and virtual blocks in the Code Generation report.
Off: Does not include a summary of eliminated and virtual blocks.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled by Create code generation report.
This parameter is selected by Model-to-code.

Command-Line Information

Parameter: GenerateTraceReport

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Traceable Simulink blocks

Include summary of Simulink blocks in Code Generation report.

Settings

Default: Off

On: Includes a summary of Simulink blocks and the corresponding code location in the Code Generation report.
Off: Does not include a summary of Simulink blocks.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled by Create code generation report.
This parameter is selected by Model-to-code.

Command-Line Information

Parameter: GenerateTraceReportSl

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Traceable Stateflow objects

Include summary of Stateflow objects in Code Generation report.

Settings

Default: Off

On: Includes a summary of Stateflow objects and the corresponding code location in the Code Generation report.
Off: Does not include a summary of Stateflow objects.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled by Create code generation report.
This parameter is selected by Model-to-code.

Command-Line Information

Parameter: GenerateTraceReportSf

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On

Traceable Embedded MATLAB functions

Include summary of Embedded MATLAB functions in Code Generation report.

Settings

Default: Off

On: Includes a summary of Embedded MATLAB functions and corresponding code locations in the Code Generation report.
Off: Does not include a summary of Embedded MATLAB functions.

Dependencies

This parameter only appears for ERT-based targets.
This parameter is enabled by Create code generation report.
This parameter is selected by Model-to-code.

Command-Line Information

Parameter: GenerateTraceReportEml

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

Application	Setting
Debugging	On
Traceability	On
Efficiency	No impact
Safety precaution	On