find - Get model elements for the category of model code mappings - MATLAB (original) (raw)

Get model elements for the category of model code mappings

Since R2020b

Syntax

Description

[modelElementsFound](#mw%5Ffe6220a9-0bc8-438f-bd27-252c326ce39a) = find([coderMapObj](#mw%5F4de9cdc7-6ad5-4b03-b922-d9fa10d7be8e),[elementCategory](#mw%5Fb6bb0461-6d0b-44d4-8f4d-ec4548e304a3)) returns the elements in the model code mappings of the specified category as an array of objects.

[modelElementsFound](#mw%5Ffe6220a9-0bc8-438f-bd27-252c326ce39a)= find([coderMapObj](#mw%5F4de9cdc7-6ad5-4b03-b922-d9fa10d7be8e),[elementCategory](#mw%5Fb6bb0461-6d0b-44d4-8f4d-ec4548e304a3),[Name=Value](#namevaluepairarguments)) returns the elements in the model code mappings of the specified category that match specified property and value criteria.

example

Examples

collapse all

Use the programmatic interface to find model elements that are related to the code mappings.

To interactively observe how your commands are reflected in the Code Mappings editor, make sure the Code Mappings editor is open with the Inports tab selected. To learn how to open the Code Mappings editor, see Open the Code Mappings Editor — C.

Open the model CoderMapAPI.

simulinkModel = "CoderMapAPI"; open_system(simulinkModel);

Retrieve the code mappings object of this model.

codeMapObj = coder.mapping.api.get(simulinkModel);

Find input port handles of ports with ImportedExtern storage class and input ports with ImportedExternPointer storage class.

importedExternInportHandles = find(codeMapObj,"Inports",StorageClass="ImportedExtern")'

importedExternInportHandles = 2×1

155.0038 157.0037

importedExternPointerInportHandles = find(codeMapObj,"Inports",StorageClass="ImportedExternPointer")'

importedExternPointerInportHandles = 2×1

159.0033 161.0024

Get the names of the input ports.

importedExterInportNames = string(get_param(importedExternInportHandles,"Name"))

importedExterInportNames = 2×1 string "in_port_1" "in_port_2"

importedExternPointerInportNames = string(get_param(importedExternPointerInportHandles,"Name"))

importedExternPointerInportNames = 2×1 string "in_port_3" "in_port_4"

Generate code from the model.

evalc("slbuild(simulinkModel)");

Root-level ports with ImportedExtern and ImportedExternPointer storage classes are declared in the generated private header file of the model in separate sections.

Store the name of the private header file.

priv_h_file = fullfile(simulinkModel+"_grt_rtw",simulinkModel+"_private.h")

priv_h_file = "CoderMapAPI_grt_rtw/CoderMapAPI_private.h"

These are the declarations of the root-level ports in the header file:

/* Imported (extern) block signals / extern real_T in_port_1; / '/in_port_1' / extern real_T in_port_2; / '/in_port_2' */

/* Imported (extern) pointer block signals */ extern real_T in_port_3; / '/in_port_3' */ extern real_T in_port_4; / '/in_port_4' */

The storage classes of the ports match the storage classes passed to the find function.

To open the header file, enter this command in the MATLAB® Command Window.

To see the ImportedExtern inports highlighted in the model canvas and in the Code Mappings editor, enter this command:

arrayfun(@(pHandle) set_param(pHandle,Selected="on"),importedExternInportHandles);

Use the programmatic interface to find entry-point functions with function customization templates mapped to the model default, and remap templates to the default customization template.

To interactively observe how your commands are reflected in the Code Mappings editor, make sure the Code Mappings editor is open with the Functions tab selected. To learn how to open the Code Mappings editor, see Open the Code Mappings Editor — C.

Open the model ECoderMapAPI.

simulinkModel = "ECoderMapAPI"; open_system(simulinkModel);

Retrieve the code mappings object of the model.

codeMapObj = coder.mapping.api.get(simulinkModel);

Use the code mappings object to find all entry-point functions with function customization template mapped to the model default. Then display the names of the functions you found.

funcObjs = find(codeMapObj,"Functions",FunctionCustomizationTemplate="Model default"); disp(funcObjs')

"Initialize"
"Terminate"
"Periodic:D1"

Map the function customization template of the functions you found to Default.

setFunction(codeMapObj,funcObjs,FunctionCustomizationTemplate="Default");

Use the find function to test if there are any entry-point functions with customization template mapped to the model default. You should get an empty list.

find(codeMapObj,"Functions",FunctionCustomizationTemplate="Model default")

ans =

0×0 empty string array

Map the function customization template of the functions you found back to model default.

setFunction(codeMapObj,funcObjs,FunctionCustomizationTemplate="Model Default");

Input Arguments

collapse all

Code mapping object returned by a call to functioncoder.mapping.api.get

Example: coderMapObj = coder.mapping.api.get(bdroot)

Model element category that you search for in the model code mappings, specified as one of these values:

Name-Value Arguments

expand all

Specify optional pairs of arguments asName1=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.

Example: find(coderMapObj,StorageClass="Bitfield")

Data Interfaces

expand all

The name of data element storage class to include in the search criteria. The storage class is either defined in the internal Embedded Coder® Dictionary of the model, or in a shared Embedded Coder Dictionary that is attached to the model.

The list of available storage classes vary depending on the specified category.

Name that the code generator uses to identify a data element in generated code. Applies to storage classes other than "Auto".

Data Types: char | string

File name for a C source file that contains definitions for global data read by data elements and external code. Applies to storage classes Const,ConstVolatile, ExportToFile, andVolatile.

Data Types: char | string

Name of a function customization template for a model that is defined in the Embedded Coder Dictionary.

Data Types: char | string

Name of an entry-point function generated for a model.

Data Types: char | string

Name of a get function that a data element calls in the generated code. Applies to storage class GetSet.

Data Types: char | string

File name for a C header file that contains declarations for global data read by data elements and external code. Applies to storage classes Const,ConstVolatile, Define,ExportToFile, GetSet,ImportedDefine, ImportFromFile, andVolatile.

Data Types: char | string

Name of a memory section for a model that is defined in the Embedded Coder Dictionary.

Data Types: char | string

Name of the model that owns global data used by other models in the same model hierarchy. The code generated for the owner model includes the global data definition. Applies to storage classes Const, ConstVolatile,ExportToFile, and Volatile.

Data Types: char | string

When model configuration parameter Array layout is set toRow-major, a flag that indicates whether to preserve dimensions of a data element that is represented in generated code as a multidimensional array. Applies to storage classes Const,ConstVolatile, ExportToFile,FileScope, GetSet,ImportFromFile, Localizable, andVolatile.

Data Types: logical

Name of a set function that a data element calls in the generated code. Applies to storage class GetSet.

Data Types: char | string

Name that the code generator uses to identify the structure for a data element in the generated code. Applies to storage classes Bitfield andStruct.

Data Types: char | string

Storage class property defined in the model Embedded Coder Dictionary. Values that you can specify vary depending on the storage class definition.

Service Interfaces

expand all

String or character vector containing the name of a receiver service interface defined in the Embedded Coder Dictionary. Within a target environment, a component receives data from other components by calling the target platform receiver service. To use the dictionary default, specify "Dictionary default".

To configure the receiver service interface, an Embedded Coder Dictionary that defines a service interface configuration must be attached to the model. For more information, see Configure Sender and Receiver Service Interfaces for Model Inports and Outports.

Data Types: char | string

String or character vector containing the name of a sender service interface defined in the Embedded Coder Dictionary. Within a target environment, a component sends data to other components by calling the target platform sender service. To use the dictionary default, specify "Dictionary default".

To configure the sender service interface, an Embedded Coder Dictionary that defines a service interface configuration must be attached to the model. For more information, see Configure Sender and Receiver Service Interfaces for Model Inports and Outports.

Data Types: char | string

String or character vector containing the name of a measurement service interface defined in the Embedded Coder Dictionary. By configuring the measurement service interface for signals, states, and data stores, you can preserve the data in the generated code for measurement. To use the dictionary default, specify "Dictionary default". If data from the state does not need to be preserved in the code, specify "Not measured".

To configure the measurement service interface, an Embedded Coder Dictionary that defines a service interface configuration must be attached to the model. For more information, see Configure Measurement Service Interfaces for Signals, States, and Data Stores.

Data Types: char | string

Data Types: char | string

Data Types: char | string

String or character vector containing the name of a timer service interface defined in the Embedded Coder Dictionary. To use the dictionary default, specify "Dictionary default".

This property is only applicable for exported functions.

To configure the timer service interface, an Embedded Coder Dictionary that defines a service interface configuration must be attached to the model. For more information, see Configure Timer Service Interfaces.

Data Types: char | string

Output Arguments

collapse all

Model elements found, returned as a string array or a handle array, depending on the specified element category.

Element Category Type of Object Returned
"Inports", "Outports", and"States" Block handle
"Signals" Port handle
"DataStores" Block handle
"ModelParameters" Model parameter name
"ModelParameterArguments" Model parameter argument name
"ModelVariantControls" Simulink.VariantControl object name
"ModelVariantControlArguments" Simulink.VariantControl model argument name
"ModelVariantVariables" Simulink.VariantVariable object name
"ExportedFunctions", "Functions","PartitionFunctions","PartitionUpdateFunctions","PeriodicFunctions","PeriodicUpdateFunctions","ResetFunctions", and"SimulinkFunctions" Function name

Version History

Introduced in R2020b

expand all

The find function now supports these values for theelementCategory argument to find Simulink.VariantControl and Simulink.VariantVariable objects in the code mapping categories.

The find function now returns model parameter arguments separately from model parameters.

Starting in R2022b, to return all elements in the model code mappings that are model parameter arguments, enter the following.

cm = coder.mapping.api.get("myConfigModel"); modelParamArgs = find(cm,"ModelParameterArguments");

To return all elements in the model code mappings that are model parameters, enter the following.

cm = coder.mapping.api.get("myConfigModel"); modelParams = find(cm,"ModelParameters");

In previous releases, specifying ModelParameters as theelementCategory argument returned both model parameters and model parameter arguments.