Code Generation Pane: Report

The Code Generation > Report pane includes the following parameters when the Simulink Coder product is installed on your system and you select a GRT-based target.

The Code Generation > Report pane includes the following parameters when the Simulink Coder product is installed on your system and you select an ERT-based target. ERT-based target parameters require an Embedded Coder license when generating code.

On this page…
Code Generation: Report Tab Overview Create code generation report Open report automatically Code-to-model Model-to-code Generate model Web view Configure Eliminated / virtual blocks Traceable Simulink blocks Traceable Stateflow objects Traceable MATLAB functions Static code metrics Summarize which blocks triggered code replacements

Code Generation: Report Tab Overview

Control the code generation report that the Simulink Coder software automatically creates.

Configuration

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

See Also

• Generate an HTML Code Generation Report

  If you have an Embedded Coder license, see also Report Generation.

• Code Generation Pane: Report

Back to Top

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 subfolder within the build folder. 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 an 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 / MATLAB Scripts, providing a complete mapping between model elements and code (requires an Embedded Coder license and the ERT target).

In the Generated Files section, 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 an 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 Code Generation > Navigate to Code (requires an Embedded Coder license and the ERT target).

• If you set the Code coverage tool parameter on the Code Generation > SIL and PIL Verification pane, you can view the code coverage data and annotations in the generated code in the HTML Code Generation Report (requires an Embedded Coder license and the ERT target).

Off

Does not generate a summary of files.

Dependency

This parameter enables and selects

• Open report automatically

• Code-to-model (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

See Also

Generate an HTML Code Generation Report

Back to Top

Open 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 folder.

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

See Also

Generate an HTML Code Generation Report

Back to Top

Code-to-model

Include hyperlinks in the code generation report that link code to the corresponding Simulink blocks, Stateflow objects, and 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 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 requires an Embedded Coder license when generating code.

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

• You must select Include comments on the Code Generation > 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

See Also

Report Generation

Back to Top

Model-to-code

Link Simulink blocks, Stateflow objects, and 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 MATLAB script in the code generation report, right-click the item and select Code Generation > 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 requires an Embedded Coder license when generating code.

• This parameter is enabled when you select Create code generation report.

• This parameter selects:

  • Eliminated / virtual blocks

  • Traceable Simulink blocks

  • Traceable Stateflow objects

  • Traceable MATLAB functions

• You must select the following parameters to use this parameter:

  • Include comments on the Code Generation > Comments tab

  • At least one of the following:

    • Eliminated / virtual blocks

    • Traceable Simulink blocks

    • Traceable Stateflow objects

    • Traceable MATLAB functions

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

See Also

Report Generation

Back to Top

Generate model Web view

Include the model Web view in the code generation report to navigate between the code and model within the same window. You can share your model and generated code outside of the MATLAB environment. You must have a Simulink Report Generator™ license to include a Web view of the model in the code generation report.

Settings

Default: Off

On

Include model Web view in the code generation report.

Off

Omit model Web view in the code generation report.

Dependencies

• This parameter only appears for ERT-based targets.

• This parameter requires an Embedded Coder license when generating code.

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

• To enable traceability between the code and model, select Code-to-model and Model-to-code.

Command-Line Information

Parameter: GenerateWebview

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

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

See Also

Include Model Web View in HTML Code Generation Report

Back to Top

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 folder containing previously-generated model code to highlight. Applying your build folder 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 requires an Embedded Coder license when generating code.

• This parameter is enabled by Model-to-code.

See Also

Report Generation

Back to Top

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 requires an Embedded Coder license when generating code.

• 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

See Also

Report Generation

Back to Top

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 requires an Embedded Coder license when generating code.

• 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

See Also

Report Generation

Back to Top

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 requires an Embedded Coder license when generating code.

• 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

See Also

Report Generation

Traceability of Stateflow Objects in Generated Code

Back to Top

Traceable MATLAB functions

Include summary of MATLAB functions in code generation report.

Settings

Default: Off

On

Includes a summary of MATLAB functions and corresponding code locations in the code generation report.

Off

Does not include a summary of MATLAB functions.

Dependencies

• This parameter only appears for ERT-based targets.

• This parameter requires an Embedded Coder license when generating code.

• 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

See Also

Report Generation

Back to Top

Static code metrics

Include static code metrics report in the code generation report.

Settings

Default: Off

On

Include static code metrics report in the code generation report. The static code metrics report does not support the C++ target language.

Off

Omit static code metrics report from the code generation report.

Dependencies

• This parameter only appears for ERT-based targets.

• This parameter requires an Embedded Coder license when generating code.

• This parameter is enabled when you select Create code generation report.

Command-Line Information

Parameter: GenerateCodeMetricsReport

Type: Boolean

Value: on | off

Default: off

Recommended Settings

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

See Also

Analyze Static Code Metrics of the Generated Code

Back to Top

Summarize which blocks triggered code replacements

Include code replacement report summarizing replacement functions used and their associated blocks in the code generation report.

Settings

Default: Off

On

Include code replacement report in the code generation report.

Note   Selecting this option also generates code replacement trace information for viewing in the Trace Information tab of the Code Replacement Viewer. The generated information can help you determine why an expected code replacement did not occur.

Off

Omit code replacement report from the code generation report.

Dependencies

• This parameter only appears for ERT-based targets.

• This parameter requires an Embedded Coder license when generating code.

• This parameter is enabled when you select Create code generation report.

Command-Line Information

Parameter: GenerateCodeReplacementReport

Type: Boolean

Value: on | off

Default: off

Recommended Settings

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

See Also

• Analyze Code Replacements in the Generated Code

• Trace Code Replacements Generated Using Your Code Replacement Library

• Determine Why Code Replacement Functions Were Not Used

Back to Top

Code Generation Pane: General

Code Generation Pane: Comments

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