Main Content

Subsystem methods

Description

Customize generated function names for reusable subsystems.

Category: Code Generation > Identifiers

Settings

Default: $R$N$M$F

Enter a macro that specifies whether, and in what order, certain text is to be included in the generated identifier. The macro can include a combination of the following format tokens.

TokenDescription
$F

Insert method name (for example, _Update for update method).

$H

Insert tag indicating system hierarchy level. For root-level blocks, the tag is the text root_. For blocks at the subsystem level, the tag is of the form sN_, where N is a unique system number assigned by the Simulink® software.

Empty for Stateflow® functions.

$M

Insert name-mangling text if required to avoid naming collisions.

Required.

$N

Insert name of object (block, signal or signal object, state, parameter or parameter object) for which identifier is being generated.

$R

Insert root model name into identifier, replacing unsupported characters with the underscore (_) character.

Required for model referencing.

$U

Insert text that you specify for the $U token. Use the Custom token text parameter to specify this text.

Tips

  • Avoid name collisions in general. One way is to avoid using default block names (for example, Gain1, Gain2...) when your model has many blocks of the same type.

  • Where possible, increase the Maximum identifier length to accommodate the length of the identifiers you expect to generate. Reserve at least three characters for name-mangling text.

  • To control the case (upper or lower case) of the text that each token represents, include decorators such as [U_] in your macro. See Control Case with Token Decorators.

  • If you specify $R, the value you specify for Maximum identifier length must be large enough to accommodate full expansions of the $R and $M tokens.

  • When a name conflict occurs between an identifier within the scope of a higher-level model and an identifier within the scope of a referenced model, the code generator preserves the identifier from the referenced model. Name mangling is performed on the identifier in the higher-level model.

  • Name mangling conventions do not apply to type names (that is, typedef statements) generated for global data types. The Maximum identifier length setting does not apply to type definitions. If you specify $R, the code generator includes the model name in the typedef.

  • This option does not impact objects (such as signals and parameters) that have a storage class other than Auto (such as ImportedExtern or ExportedGlobal).

  • For referenced models, if the Subsystem methods parameter does not contain a $R token (which represents the name of the reference model), code generation prepends the $R token to the identifier format.

    You can use the Model Advisor to identify models in a model referencing hierarchy for which code generation changes configuration parameter settings.

    1. On the Modeling tab, select Model Advisor.

    2. Select By Task.

    3. Run the Check code generation identifier formats used for model reference check.

Dependency

This parameter:

  • Appears only for ERT-based targets.

  • Requires Embedded Coder® when generating code.

Command-Line Information

Parameter: CustomSymbolStrFcn
Type: character vector
Value: valid combination of tokens
Default: $R$N$M$F

Recommended Settings

ApplicationSetting
DebuggingNo impact
TraceabilityUse default
EfficiencyNo impact
Safety precautionNo recommendation

Related Topics