Main Content

getFunction

Get code configuration from code mappings for model function

    Description

    example

    propertyValue = getFunction(myCodeMappingObj,function,property) returns the value of a property for the specified model function. Use this function to return the function customization template or memory section configured for a model function. For single-tasking periodic functions for which you previously set an argument specification and for Simulink functions, use this function to return the argument specification.

    Examples

    collapse all

    For model myConfigModel, get the function name that is configured for the model initialize function from the model code mappings.

    cm = coder.mapping.api.get('myConfigModel');
    initFunctionName = getFunction(cm,'Initialize','FunctionName');
    

    For model myConfigModel, get the memory section that is configured for the model periodic single-tasking function from the model code mappings.

    cm = coder.mapping.api.get('myConfigModel');
    periodicFunctionMemSec = getFunction(cm,'Periodic','MemorySection');
    

    For model myConfigModel, get the function customization template that is configured for the model periodic multitasking function that corresponds to sample time D2 from the model code mappings.

    cm = coder.mapping.api.get('myConfigModel');
    periodicD2FunctionTemp = getFunction(cm,'Periodic:D2','FunctionCustomizationTemplate');
    

    For model myConfigModel, get the function argument specification (names, port type, qualifiers, and order) that is configured for the model Simulink function mySLFunc from the model code mappings.

    cm = coder.mapping.api.get('myConfigModel');
    mySLFuncArgs = getFunction(cm,'SimulinkFunction:mySLFunc','Arguments');
    

    Input Arguments

    collapse all

    Code mapping object (model code mappings) returned by a call to function coder.mapping.api.get.

    Example: myCM

    Model function for which to return a code mapping property value. Specify one of the values listed in this table. If model configuration parameter Single output/update function is cleared, you can specify the update version of a partition, periodic multi-tasking, or periodic singletasking function.

    Type of Model FunctionValue
    Exported functionExportedFunction:slIdentifier, where slIdentifier is the name of the function-call Inport block in the model
    Initialize functionInitialize
    Partition functionPartition:slIdentifier, where slIdentifier is a partition that was created explicitly from a block in the model and shown in the Simulink® Schedule Editor (for example, P1)
    Partition update function PartitionUpdate:slIdentifier, is a partition that was created explicitly from a block in the model and shown in the Simulink Schedule Editor (for example, P1)
    Periodic multitasking functionPeriodic:slIdentifier, where slIdentifier is an annotation that corresponds to the sample time period for a periodic or continuous rate of a multi-tasking model (for example, D1)
    Periodic multitasking update functionPeriodicUpdate:slIdentifier, where slIdentifier is an annotation that corresponds to the sample time period for a periodic or continuous rate of a multi-tasking model (for example, D1)
    Periodic single-tasking functionPeriodic
    Periodic single-tasking update functionPeriodicUpdate
    Reset functionReset:slIdentifier, where slIdentifier is the name of the reset function in the model
    Simulink functionSimulinkFunction:slIdentifier, where slIdentifier is the name of the Simulink function in the model
    Terminate functionTerminate

    For information about model partitioning, see Create Partitions.

    Example: 'Periodic:D1'

    Code mapping property value to return. Specify one of the property names listed in this table.

    Information to ReturnProperty Name
    Function customization template setting for the specified functionFunctionCustomizationTemplate
    Memory section associated with the specified functionMemorySection
    Name to use for the function in the generated codeFunctionName
    For periodic, single-tasking functions and Simulink functions, a string that shows the names, type qualifiers, and order of arguments as they will appear in the generated code Arguments

    Example: 'FunctionCustomizationTemplate'

    Output Arguments

    collapse all

    Name of the function customization template, memory section, function, or argument specification returned as a character vector or string scalar.

    Data Types: char | string

    Introduced in R2020b