Simulation Target Pane: Custom Code

On this page…
Simulation Target: Custom Code Tab Overview Parse custom code symbols Source file Header file Initialize function Terminate function Include directories Source files Libraries Use local custom code settings (do not inherit from main model)

Simulation Target: Custom Code Tab Overview

Include custom code settings for a model that contains MATLAB Function blocks, Stateflow charts, or Truth Table blocks.

Configuration

1. Select the type of information to include from the list on the left side of the pane.

2. Enter a string to identify the specific code, folder, source file, or library.

3. Click Apply.

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Parse custom code symbols

Specify whether or not to parse the custom code and report unresolved symbols in a model. This setting applies to all charts in the model, including library link charts.

Settings

Default: On

On

Enables parsing of custom code to report unresolved symbols in charts of your model.

Off

Disables parsing of custom code.

Tips

• When you create a new model, this check box is selected by default.

• When you load models saved as version R2010a or earlier, this check box is selected only if the mex compiler is lcc. Otherwise, the check box is not selected.

Command-Line Information

Parameter: SimParseCustomCode

Type: string

Value: 'on' | 'off'

Default: 'on'

Recommended Settings

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

See Also

• Including Custom C Code

• Resolving Symbols in Stateflow Charts

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Source file

Enter code lines to appear near the top of a generated source code file.

Settings

Default: ' '

Code lines appear near the top of the generated model.c source file, outside of any function.

Command-Line Information

Parameter: SimCustomSourceCode

Type: string

Value: any source file name

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Header file

Enter code lines to appear near the top of a generated header file.

Settings

Default: ' '

Code lines appear near the top of the generated model.h header file.

Tips

• When you include a custom header file, enclose the file name in double quotes. For example, #include "sample_header.h" is a valid declaration for a custom header file.

• You can include extern declarations of variables or functions.

Command-Line Information

Parameter: SimCustomHeaderCode

Type: string

Value: any header file name

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Initialize function

Enter code statements that execute once at the start of simulation.

Settings

Default: ' '

Code appears inside the model's initialize function in the model.c file.

Tip

• Use this code to invoke functions that allocate memory or to perform other initializations of your custom code.

Command-Line Information

Parameter: SimCustomInitializer

Type: string

Value: any code

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Terminate function

Enter code statements that execute at the end of simulation.

Settings

Default: ' '

Code appears inside the model's terminate function in the model.c file.

Tip

• Use this code to invoke functions that free memory allocated by the custom code or to perform other cleanup tasks.

Command-Line Information

Parameter: SimCustomTerminator

Type: string

Value: any code

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Include directories

Specify a list of folder paths that contain files you include in the compiled target.

Settings

Default:''

Enter a space-separated list of folder paths.

• Specify absolute or relative paths to the directories.

• Relative paths must be relative to the folder containing your model files, not relative to the build folder.

• The order in which you specify the directories is the order in which they are searched for header, source, and library files.

Note   If you specify a Windows® path string containing one or more spaces, you must enclose the string in double quotes. For example, the second and third path strings in the Include directories entry below must be double-quoted: C:\Project "C:\Custom Files" "C:\Library Files" If you set the equivalent command-line parameter SimUserIncludeDirs, each path string containing spaces must be separately double-quoted within the single-quoted third argument string, for example, >> set_param('mymodel', 'SimUserIncludeDirs', ... 'C:\Project "C:\Custom Files" "C:\Library Files"')

Command-Line Information

Parameter: SimUserIncludeDirs

Type: string

Value: any folder file name

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Source files

Specify a list of source files to compile and link into the target.

Settings

Default:''

You can separate source files with a comma, a space, or a new line.

Limitation

This parameter does not support Windows file names that contain embedded spaces.

Tip

• The file name is sufficient if the file is in the current MATLAB folder or in one of the include directories.

Command-Line Information

Parameter: SimUserSources

Type: string

Value: any source file name

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Libraries

Specify a list of static libraries that contain custom object code to link into the target.

Settings

Default:''

Enter a space-separated list of library files.

Limitation

This parameter does not support Windows file names that contain embedded spaces.

Tip

• The file name is sufficient if the file is in the current MATLAB folder or in one of the include directories.

Command-Line Information

Parameter: SimUserLibraries

Type: string

Value: any library file name

Default: ''

Recommended Settings

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

See Also

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Use local custom code settings (do not inherit from main model)

Specify if a library model can use custom code settings that are unique from the main model.

Settings

Default: Off

On

Enables a library model to use custom code settings that are unique from the main model.

Off

Disables a library model from using custom code settings that are unique from the main model.

Dependency

This parameter is available only for library models that contain MATLAB Function blocks, Stateflow charts, or Truth Table blocks. To access this parameter, select Tools > Open Simulation Target in the MATLAB Function Block Editor or Stateflow Editor for your library model.

Command-Line Information

Parameter: SimUseLocalCustomCode

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

• Including Custom C Code

• Configuration Parameters Dialog Box

• Simulation Target Pane: Custom Code

Back to Top

Simulation Target Pane: Symbols

Library Browser

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