Main Content

find

Get model elements for the category of model code mappings

    Description

    example

    modelElementsFound= find(myCodeMappingObj,category) returns the elements in the model code mappings of the specified category as an array of objects.

    example

    modelElementsFound= find(myCodeMappingObj,category,Name,Value) returns the elements in the model code mappings of the specified category that match specified property and value criteria.

    Examples

    collapse all

    In the model code mappings for model myConfigModel, find model workspace parameters.

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

    For model myConfigModel, find Inport blocks that have storage class set to Auto. For each Inport block found, change the storage class setting to Model default.

    cm = coder.mapping.api.get('myConfigModel');
    inportBlkHandles = find(cm,'Inports','StorageClass','Auto');
    setInport(cm,inportBlkHandles,'StorageClass','Model default');
    

    For model myConfigModel, find functions that are configured to use the model default setting for memory sections. For each function found, change the memory section setting to None.

    cm = coder.mapping.api.get('myConfigModel');
    functionObjects = find(cm,'Functions','MemorySection','Model default');
    setFunction(cm,funcitonObjects,'MemorySection','None');
    

    Input Arguments

    collapse all

    Code mapping object returned by a call to function coder.mapping.api.get.

    Example: myCM

    Category of model elements that you search for in the model code mappings.

    Example: 'Inports'

    Name-Value Arguments

    Example: 'Identifier','mp_table1'

    Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments as Name1,Value1,…,NameN,ValueN. The order of the name and value pair arguments does not matter.

    Data Interfaces

    collapse all

    Data element storage class to include in code mappings search criteria. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. Values that you can specify vary depending on the category that you specify.

    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, and Volatile.

    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, and Volatile.

    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 to Row-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, and Volatile.

    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 and Struct.

    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

    collapse 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, the model must be linked to a service interface configuration. 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, the model must be linked to a service interface configuration. 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, the model must be linked to a service interface configuration. For more information, see Configure Measurement Service Interfaces for Signals, States, and Data Stores.

    Data Types: char | string

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

    To configure the parameter tuning service interface, the model must be linked to a service interface configuration. For more information, see Configure Parameter and Parameter Argument Tuning Service Interfaces for Model Parameters and Model Parameter Arguments.

    Data Types: char | string

    String or character vector containing the name of a parameter argument tuning service interface defined in the Embedded Coder Dictionary. To use the dictionary default, specify 'Dictionary default'.

    To configure the parameter argument tuning service interface, the model must be linked to a service interface configuration. For more information, see Configure Parameter and Parameter Argument Tuning Service Interfaces for Model Parameters and Model Parameter Arguments.

    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, the model must be linked to a service interface configuration. For more information, see Configure Timer Service Interfaces for Aperiodic Export Functions.

    Data Types: char | string

    Output Arguments

    collapse all

    Model elements found, returned as an array or string vector of objects. Each object identifies a model element of the specified category. If you specify additional search criteria, the array or string vector includes objects for model elements of the specified category that meet the additional search criteria. The object returned for an element depends on the category that you specify.

    CategoryType of Object Returned
    Inports, Outports, and StatesBlock handle
    SignalsPort handle
    DataStoresBlock handle
    ModelParametersModel parameter name
    ModelParameterArgumentsModel parameter argument name
    ExportedFunctions, Functions, PartitionFunctions, PartitionUpdateFunctions, PeriodicFunctions, PeriodicUpdateFunctions, ResetFunctions, and SimulinkFunctionsFunction

    Version History

    Introduced in R2020b

    expand all