Learn more about Real-Time Workshop

Real-Time Workshop Pane: General

When the Real-Time Workshop product is installed on your system and you select a GRT-based target, the Real-Time Workshop General pane includes the following parameters.

When the Real-Time Workshop product is installed on your system and you select an ERT-based target, the Real-Time Workshop General pane includes the following parameters. ERT-based target parameters require a Real-Time Workshop Embedded Coder license when generating code.

On this page…

Real-Time Workshop: General Tab Overview System target file Language Compiler optimization level Custom compiler optimization flags TLC options Generate makefile Make command Template makefile Ignore custom storage classes Ignore test point signals Select objective Prioritized objectives Set objectives Configuration Set Objectives Dialog Box Check model Check model before generating code Generate code only Build/Generate code

Real-Time Workshop: General Tab Overview

Set up general information about code generation for a model's active configuration set, including target selection, documentation, and build process parameters.

See Also

Real-Time Workshop Pane

Back to Top

System target file

Specify the system target file.

Settings

Default: grt.tlc

You can specify the system target file in these ways:

• Use the System Target File Browser. Click the Browse button, which lets you select a preset target configuration consisting of a system target file, template makefile, and make command.

• Enter the name of your system target file in this field.

Tips

• The System Target File Browser lists all system target files found on the MATLAB path. Some system target files require additional licensed products, such as the Real-Time Workshop Embedded Coder product.

• To configure your model for rapid simulation, select rsim.tlc.

• To configure your model for xPC Target™, select xpctarget.tlc or xpctargetert.tlc.

Command-Line Information

Parameter: SystemTargetFile

Type: string

Value: any valid system target file

Default: 'grt.tlc'

Recommended Settings

Application	Setting
Debugging	No impact
Traceability	No impact
Efficiency	No impact
Safety precaution	No impact (GRT) ERT based (requires Real-Time Workshop Embedded Coder license)

See Also

• Available Targets

• Generating Efficient Code with Optimized ERT Targets

• Auto-Configuring Models for Code Generation

• Creating and Using Host-Based Shared Libraries

Back to Top

Language

Specify C or C++ code generation.

Settings

Default: C

C

Generates .c files and places the files in your build directory.

C++

Generates C++ compatible .cpp files and places the files in your build directory.

C++ (Encapsulated)

Generates C++ encapsulated .cpp files and places the files in your build directory. Selecting this value causes the build to generate a C++ class interface to model code. The generated interface encapsulates all required model data into C++ class attributes and all model entry point functions into C++ class methods.

Note   Using C++ (Encapsulated) for code generation requires a Real-Time Workshop Embedded Coder license and the ERT target. The value C++ (Encapsulated) appears in the Language menu if you select an ERT target for your model, but you cannot use the ERT target and the C++ (Encapsulated) value for model building without a Real-Time Workshop Embedded Coder license.

Tip

You might need to configure the Real-Time Workshop software to use the appropriate compiler before you build a system.

Command-Line Information

Parameter: TargetLang

Type: string

Value: 'C' | 'C++' | 'C++ (Encapsulated)'

Default: 'C'

Recommended Settings

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

See Also

Choosing and Configuring a Compiler

Back to Top

Compiler optimization level

Provides flexible and generalized control over compiler optimizations for building generated code.

Settings

Default: Optimizations off (faster builds)

Optimizations off (faster builds)

Customizes compilation during the Real-Time Workshop makefile build process to minimize compilation time.

Optimizations on (faster runs)

Customizes compilation during the Real-Time Workshop makefile build process to minimize run time.

Custom

Allows you to specify custom compiler optimization flags to be applied during the Real-Time Workshop makefile build process.

Tips

• Target-independent values Optimizations on (faster runs) and Optimizations off (faster builds) allow you to easily toggle compiler optimizations on and off during code development.

• Custom allows you to enter custom compiler optimization flags at Simulink GUI level, rather than editing compiler flags into template makefiles (TMFs) or supplying compiler flags to Real-Time Workshop make commands.

• If you specify compiler options for your Real-Time Workshop makefile build using OPT_OPTS, MEX_OPTS (except MEX_OPTS="-v"), or MEX_OPT_FILE, the value of Compiler optimization level is ignored and a warning is issued about the ignored parameter.

Dependencies

This parameter enables Custom compiler optimization flags.

Command-Line Information

Parameter: RTWCompilerOptimization

Type: string

Value:'Off' | 'On' | 'Custom'

Default: 'Off'

Recommended Settings

Application	Setting
Debugging	Optimizations off (faster builds)
Traceability	Optimizations off (faster builds)
Efficiency	Optimizations on (faster runs)
Safety precaution	No impact

See Also

• Custom compiler optimization flags

• Controlling Compiler Optimization Level and Specifying Custom Optimization Settings

Back to Top

Custom compiler optimization flags

Specify compiler optimization flags to be applied to building the generated code for your model.

Settings

Default: ''

Specify compiler optimization flags without quotes, for example, -O2.

Dependency

This parameter is enabled by selecting the value Custom for the parameter Compiler optimization level.

Command-Line Information

Parameter: RTWCustomCompilerOptimizations

Type: string

Value:"" | user-specified flags

Default: ""

Recommended Settings

See Compiler optimization level.

See Also

• Compiler optimization level

• Controlling Compiler Optimization Level and Specifying Custom Optimization Settings

Back to Top

TLC options

Specify Target Language Compiler (TLC) options for code generation.

Settings

Default: ''

You can enter TLC command-line options and arguments.

Tips

• Specifying TLC options does not add flags to the Make command field.

• The summary section of the generated HTML report lists the TLC options that you specify for the build in which you generate the report.

Command-Line Information

Parameter: TLCOptions

Type: string

Value: any valid TLC argument

Default: ''

Recommended Settings

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

See Also

• TLC Options

• Command-Line Arguments

• Customizing the Target Build Process with the STF_make_rtw Hook File

• Understanding and Using the Build Process

Back to Top

Generate makefile

Specify generation of a makefile.

Settings

Default: on

On

Generates a makefile for a model during the build process.

Off

Suppresses the generation of a makefile. You must set up any post code generation build processing, including compilation and linking, as a user-defined command.

Dependencies

This parameter enables:

• Make command

• Template makefile

Command-Line Information

Parameter: GenerateMakefile

Type: string

Value: 'on' | 'off'

Default: 'on'

Recommended Settings

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

See Also

• Customizing Post Code Generation Build Processing

• Customizing the Target Build Process with the STF_make_rtw Hook File

• Understanding and Using the Build Process

Back to Top

Make command

Specify a make command and optionally append make command arguments.

Settings

Default: make_rtw

The make command, a high-level M-file command, invoked when you start a build, controls the Real-Time Workshop build process.

• Each target has an associated make command, automatically supplied when you select a target file using the System Target File Browser.

• Some third-party targets supply a make command. See the vendor's documentation.

• You can specify arguments in the Make command field which pass into the makefile-based build process. Append the arguments after the make command, as in the following example:

  make_rtw OPTS="-DMYDEFINE=1"

  The syntax for make command options differs slightly for different compilers.

Tip

Most targets use the default command.

Dependency

This parameter is enabled by Generate makefile.

Command-Line Information

Parameter: MakeCommand

Type: string

Value: any valid make command M-file

Default: 'make_rtw'

Recommended Settings

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

See Also

• Template Makefiles and Make Options

• Customizing the Target Build Process with the STF_make_rtw Hook File

• Understanding and Using the Build Process

Back to Top

Template makefile

Specify a template makefile.

Settings

Default: grt_default_tmf

The template makefile determines which compiler runs, during the make phase of the build, to compile the generated code. You can specify template makefiles in the following ways:

• Generate a value by selecting a target configuration using the System Target File Browser.

• Explicitly enter a custom template makefile filename (including the extension). The file must be on the MATLAB path.

Tips

• If you do not include a filename extension for a custom template makefile, the code generator attempts to find and execute an M-file.

• You can customize your build process by modifying an existing template makefile or by providing your own template makefile.

Dependency

This parameter is enabled by Generate makefile.

Command-Line Information

Parameter: TemplateMakefile

Type: string

Value: any valid template makefile filename

Default: 'grt_default_tmf'

Recommended Settings

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

See Also

• Template Makefiles and Make Options

• Available Targets

Back to Top

Ignore custom storage classes

Specify whether to apply or ignore custom storage classes.

Settings

Default: off

On

Ignores custom storage classes by treating data objects that have them as if their storage class attribute is set to Auto. Data objects with an Auto storage class do not interface with external code and are stored as local or shared variables or in a global data structure.

Off

Applies custom storage classes as specified. You must clear this option if the model defines data objects with custom storage classes.

Tips

• Clear this parameter before configuring data objects with custom storage classes.

• Setting for top-level and referenced models must match.

Dependencies

• This parameter only appears for ERT-based targets.

• Clear this parameter to enable module packaging features.

• This parameter requires a Real-Time Workshop Embedded Coder license when generating code.

Command-Line Information

Parameter: IgnoreCustomStorageClasses

Type: string

Value: 'on' | 'off

Default: 'off'

Recommended Settings

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

See Also

Custom Storage Classes

Back to Top

Ignore test point signals

Specify allocation of memory buffers for test points.

Settings

Default: Off

On

Ignores all test points during code generation, allowing optimal buffer allocation for signals with test points, facilitating transition from prototyping to deployment and avoiding accidental degradation of generated code due to workflow artifacts.

Off

Allocates separate memory buffers for test points, resulting in a loss of code generation optimizations such as reducing memory usage by storing signals in reusable buffers.

Dependencies

• This parameter appears only for ERT-based targets.

• This parameter requires a Real-Time Workshop Embedded Coder license when generating code.

Command-Line Information

Parameter: IgnoreTestpoints

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

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

See Also

• Signals with Test Points in the Real-Time Workshop User's Guide

• Working with Test Points in the Simulink User's Guide

• Signal Considerations in the Real-Time Workshop User's Guide

Back to Top

Select objective

Select code generation objectives to use with the Code Generation Advisor.

Settings

Default: Unspecified

Unspecified

No objective specified. Do not optimize code generation settings using the Code Generation Advisor.

Debugging

Specifies debugging objective. Optimize code generation settings for debugging the code generation build process using the Code Generation Advisor.

Tips

For more objectives, specify an ERT-based target.

Dependency

This parameter appears only for GRT-based targets.

Command-Line Information

Parameter: 'ObjectivePriorities'

Type: cell array of strings

Value: {''} | {'Debugging'}

Default: {''}

Recommended Settings

Application	Setting
Debugging	Debugging
Traceability	Not applicable for GRT-based targets
Efficiency	Not applicable for GRT-based targets
Safety precaution	Not applicable for GRT-based targets

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Prioritized objectives

Lists objectives that you specify by clicking the Set objectives button.

Dependencies

• This parameter appears only for ERT-based targets.

• This parameter requires a Real-Time Workshop Embedded Coder license when generating code.

Command-Line Information

Command: get_param('model', 'ObjectivePriorities')

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Set objectives

Opens Configuration Set Objectives dialog box.

Dependency

This button appears only for ERT-based targets.

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Configuration Set Objectives Dialog Box

Select and prioritize code generation objectives to use with the Code Generation Advisor.

Settings

1. From the Available objectives list, select objectives.

2. Click the select button (arrow pointing right) to move the objectives that you selected into the Selected objectives - prioritized list.

3. Click the higher priority (up arrow) and lower priority (down arrow) buttons to prioritize the objectives.

Objectives.   List of available objectives.

Efficiency — Configure code generation settings to reduce RAM, ROM, and execution time.

Traceability — Configure code generation settings to provide mapping between model elements and code.

Safety precaution — Configure code generation settings to increase clarity, determinism, robustness, and verifiability of the code.

Debugging — Configure code generation settings to debug the code generation build process.

Priorities.   After you select objectives from the Available objectives parameter, organize the objectives in the Selected objectives - prioritized parameter with the highest priority objective at the top.

Dependency

This dialog box appears only for ERT-based targets.

Command-Line Information

Parameter: 'ObjectivePriorities'

Type: cell array of strings; any combination of the available values

Value: {''} | {'Efficiency'} | {'Traceability'} | {'Safety precaution'} | {'Debugging'}

Default: {''}

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Check model

Runs the Code Generation Advisor checks.

Settings

1. Specify code generation objectives using the Select objective parameter (available with GRT-based targets) or in the Configuration Set Objectives dialog box, by clicking Set objectives (available with ERT-based targets).

2. Click Check model. The Code Generation Advisor runs the code generation objectives checks.

Dependency

You must specify objectives before checking the model.

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Check model before generating code

Choose whether to run Code Generation Advisor checks before generating code.

Settings

Default: Off

Off

Generates code without checking whether the model meets code generation objectives. The code generation report summary and file headers indicate the specified objectives and that the validation was not run.

On (proceed with warnings)

Checks whether the model meets code generation objectives using the Code Generation Objectives checks in the Code Generation Advisor. If the Code Generation Advisor reports a warning, the Real-Time Workshop software continues generating code. The code generation report summary and file headers indicate the specified objectives and the validation result.

On (stop for warnings)

Checks whether the model meets code generation objectives using the Code Generation Objectives checks in the Code Generation Advisor. If the Code Generation Advisor reports a warning, the Real-Time Workshop software does not continue generating code.

Command-Line Information

Parameter: CheckMdlBeforeBuild

Type: string

Value: 'Off' | 'Warning' | 'Error'

Default: 'Off'

Recommended Settings

Application	Setting
Debugging	On (proceed with warnings) or On (stop for warnings)
Traceability	On (proceed with warnings) or On (stop for warnings)
Efficiency	On (proceed with warnings) or On (stop for warnings)
Safety precaution	On (proceed with warnings) or On (stop for warnings)

See Also

• Mapping Application Objectives to Model Configuration Parameters in the Real-Time Workshop Embedded Coder documentation.

• Configuring Code Generation Objectives in the Real-Time Workshop User's Guide.

Back to Top

Generate code only

Specify code generation versus an executable build.

Settings

Default: off

On

The caption of the Build/Generate code button becomes Generate code. The build process generates code and a makefile, but it does not invoke the make command.

Off

The caption of the Build/Generate code button becomes Build. The build process generates and compiles code, and creates an executable file.

Tip

Generate code only generates a makefile only if you select Generate makefile.

Dependency

This parameter changes the function of the Build/Generate code button.

Command-Line Information

Parameter: GenCodeOnly

Type: string

Value: 'on' | 'off'

Default: 'off'

Recommended Settings

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

See Also

Customizing Post Code Generation Build Processing

Back to Top

Build/Generate code

Start the build or code generation process.

Tip

You can also start the build process by pressing Ctrl+B.

Dependency

When you select Generate code only, the caption of the Build button changes to Generate code.

Command-Line Information

Command: rtwbuild

Type: string

Value: 'modelname'

Recommended Settings

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

See Also

Initiating the Build Process

Back to Top

Configuration Parameters for Simulink Models

Real-Time Workshop Pane: Report

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