rtwbuild

(Not recommended) Build generated code from a model

rtwbuild is not recommended. Use slbuild instead.

Syntax

rtwbuild(model)

rtwbuild(model,Name,Value)

rtwbuild(subsystem)

rtwbuild(subsystem,'Mode','ExportFunctionCalls')

blockHandle = rtwbuild(subsystem,'Mode','ExportFunctionCalls')

Description

rtwbuild(model) generates code from model based on current model configuration parameter settings. If model is not already loaded into the MATLAB^® environment, rtwbuild loads it before generating code.

If you clear the Generate code only model configuration parameter, the function generates code and builds an executable image.

To reduce code generation time, when rebuilding a model, rtwbuild provides incremental model build. The code generator rebuilds a model or submodels only when they have changed since the most recent model build. To force a top-model build, see the 'ForceTopModelBuild' argument.

rtwbuild(model,Name,Value) uses additional options specified by one or more Name,Value pair arguments.

rtwbuild(subsystem) generates code from subsystem based on current model configuration parameter settings. Before initiating the build, open (or load) the parent model.

If you clear the Generate code only model configuration parameter, the function generates code and builds an executable image.

rtwbuild(subsystem,'Mode','ExportFunctionCalls') generates code from subsystem that includes function calls that you can export to external application code if you have Embedded Coder^®.

blockHandle = rtwbuild(subsystem,'Mode','ExportFunctionCalls') returns the handle to a SIL block created for code generated from the specified subsystem if the Create block configuration parameter is set to SIL and if you have Embedded Coder. You can then use the SIL block for numerical equivalence testing.

Examples

Generate Code and Build Executable Image for Model

Generate C code for model rtwdemo_rtwintro.

rtwbuild('rtwdemo_rtwintro')

For the GRT system target file, the code generator produces the following code files and places them in folders rtwdemo_rtwintro_grt_rtw and slprj/grt/_sharedutils.

Model Files	Shared Files	Interface Files
rtwdemo_rtwintro.c rtwdemo_rtwintro.h rtwdemo_rtwintro_private.h rtwdemo_rtwintrotypes.h	rtGetInf.c rtGetInf.h rtGetNaN.c rtGetNaN.h rt_nonfinite.c rt_nonfinite.h rtwtypes.h multiword_types.h builtin_typeid_types.h	rtmodel.h

If the following model configuration parameters settings apply, the code generator produces additional results.

Parameter Setting	Results
Code Generation > Generate code only is cleared	Executable image rtwdemo_rtwintro.exe
Code Generation > Report > Create code generation report is selected	Report that provides information and links to generated code files, subsystem and code interface reports, entry-point functions, inports, outports, interface parameters, and data stores

Force Top Model Build

Generate code and build an executable image for TopModelCode, which refers to model ReferenceModelCode, regardless of model checksums and parameter settings.

openExample('simulinkcoder/FilePackagingModelsCodeAndDataExample', 'supportingFile', 'TopModelCode');
rtwbuild('TopModelCode', ...
    'ForceTopModelBuild',true)

Generate Code and Build Executable Image for Subsystem

Generate C code for subsystem Amplifier in model rtwdemo_rtwintro.

rtwbuild('rtwdemo_rtwintro/Amplifier')

For the GRT target, the code generator produces the following code files and places them in folders Amplifier_grt_rtw and slprj/grt/_sharedutils.

Model Files	Shared Files	Interface Files
Amplifier.c Amplifier.h Amplifier_private.h Amplifier_types.h	rtGetInf.c rtGetInf.h rtGetNaN.c rtGetNaN.h rt_nonfinite.c rt_nonfinite.h rtwtypes.h multiword_types.h builtin_typeid_types.h	rtmodel.h

If you apply the parameter settings listed in the table, the code generator produces the results listed.

Parameter Setting	Results
Code Generation > Generate code only is cleared	Executable image Amplifier.exe
Code Generation > Report > Create code generation report is selected	Report that provides information and links to generated code files, subsystem and code interface reports, entry-point functions, inports, outports, interface parameters, and data stores

Build Subsystem for Exporting Code to External Application

To export the image to external application code, build an executable image from a function-call subsystem.

rtwdemo_exporting_functions
rtwbuild('rtwdemo_exporting_functions/rtwdemo_subsystem','Mode','ExportFunctionCalls')

The executable image rtwdemo_subsystem.exe appears in your working folder.

Create SIL Block for Verification

From a function-call subsystem, create a SIL block that you can use to test the code generated from a model.

Open subsystem rtwdemo_subsystem in model rtwdemo_exporting_functions and set the Create block model configuration parameter to SIL.

Create the SIL block.

mysilblockhandle = rtwbuild('rtwdemo_exporting_functions/rtwdemo_subsystem',...
'Mode','ExportFunctionCalls')

The code generator produces a SIL block for the generated subsystem code. You can add the block to an environment or test harness model that supplies test vectors or stimulus input. You can then run simulations that perform SIL tests and verify that the generated code in the SIL block produces the same result as the original subsystem.

Name Exported Initialization Function

Name the initialization function generated when building an executable image from a function-call subsystem.

rtwdemo_exporting_functions
rtwbuild('rtwdemo_exporting_functions/rtwdemo_subsystem',...
'Mode','ExportFunctionCalls','ExportFunctionInitializeFunctionName','subsysinit')

The initialization function name subsysinit appears in rtwdemo_subsystem_ert_rtw/ert_main.c.

Display Status Information in Build Status Window

Display build information in the Build Status window while generating code and running a parallel build of model rtwdemo_mdlreftop_witherr.

rtwbuild('rtwdemo_mdlreftop_witherr', ...
    'OpenBuildStatusAutomatically',true)

Input Arguments

model — Model object or name for which to generate code or build an executable image

object | 'modelName'

Model for which to generate code or build an executable image, specified as an object or a character vector representing the model name.

Example: 'rtwdemo_exporting_functions'

subsystem — Subsystem name for which to generate code or build executable image

'subsystemName'

Subsystem for which to generate code or build an executable image, specified as a character vector representing the subsystem name or the full block path.

Example: 'rtwdemo_exporting_functions/rtwdemo_subsystem'

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: rtwbuild('TopModelCode','ForceTopModelBuild',true)

ForceTopModelBuild — Force regeneration of top model code

false (default) | true

Force regeneration of top model code, specified as true or false.

Action	Specify
Force the code generator to regenerate code for the top model of a system that includes referenced models	true
Specify that the code generator determine whether to regenerate top model code based on model and model parameter changes	false

Consider forcing regeneration of code for a top model if you change items associated with external or custom code, such as code for a custom target. For example, set ForceTopModelBuild to true if you change:

• TLC code

• S-function source code, including rtwmakecfg.m files

• Integrated custom code

Alternatively, you can force regeneration of top model code by deleting folders in the Code generation folder, such as slprj or the generated model code folder.

generateCodeOnly — Generate code only

false | true

If you do not specify a value, the Generate code only (GenCodeOnly) option on the Code Generation pane controls build process behavior.

If you specify a value, the argument overrides the Generate code only (GenCodeOnly) option on the Code Generation pane.

Action	Specify
Generate code only.	true
Generate code and build executable file.	false

Mode — Export function calls (for subsystem builds only)

'ExportFunctionCalls' | 'Normal'

• 'ExportFunctionCalls' –– If you have Embedded Coder, generates code from subsystem that includes function calls that you can export to external application code.

• 'Normal' –– Does not export function calls.

ExportFunctionInitializeFunctionName — Function name

character vector

Name the exported initialization function for specified subsystem.

Example: rtwbuild(subsystem,'Mode','ExportFunctionCalls','ExportFunctionInitializeFunctionName', fcnname)

OpenBuildStatusAutomatically — Display build information in the Build Status window

false (default) | true

Display build information in the Build Status window, specified as true or false. For more information about using the Build Status window, see Monitor Parallel Building of Referenced Models.

The Build Status window supports parallel builds of referenced model hierarchies. Do not use the Build Status window for serial builds.

Action	Specify
Display build information in the Build Status window	true
No action	false

ObfuscateCode — Generate obfuscated C code

false (default) | true

Specify whether to generate obfuscated C code, specified as true or false.

Action	Specify
Generate obfuscated C code that you can share with third parties with reduced likelihood of compromising intellectual property.	true
No action.	false

IncludeModelReferenceSimulationTargets — Option to build model reference simulation targets

false (default) | true

Option to build model reference simulation targets, specified as the comma-separated pair consisting of 'IncludeModelReferenceSimulationTargets' and true or false.

Data Types: logical

Output Arguments

blockHandle — Handle to SIL block created for generated subsystem code

handle

Handle to SIL block created for generated subsystem code. Returned only if both of the following conditions apply:

• You are licensed to use Embedded Coder software.

• Create block model configuration parameter is set to SIL.

Tips

You can initiate code generation and the build process by:

• Pressing Ctrl+B.

• Selecting Code > C/C++ Code > Build Model.

• Invoking the slbuild command from the MATLAB command line.

Extended Capabilities

Automatic Parallel Support

Accelerate code by automatically running computation in parallel using Parallel Computing Toolbox™.

To build referenced models in parallel, in the top model, select the configuration parameter check box Enable parallel model reference builds. For more information, see Reduce Build Time for Referenced Models by Using Parallel Builds.

In Parallel Computing Toolbox™ commands, for example, a parfor or spmd loop, do not invoke rtwbuild, rtwrebuild, or slbuild commands that build models that are configured for parallel builds.

Version History

Introduced in R2009a

R2020b: rtwbuild does not generate model reference simulation targets by default

Starting in R2020b, the rtwbuild function does not generate model reference simulation targets by default. Excluding the model reference simulation targets allows for faster code generation for model hierarchies.

You can continue to generate both the simulation and code generation targets with the rtwbuild function by using the IncludeModelReferenceSimulationTargets argument.