Real-Time Workshop^® Embedded Coder™

registerCFunctionEntry

Create TFL function entry based on specified parameters and register in TFL table

Syntax

TflCFunctionEntry* registerCFunctionEntry(hTable, priority,
                                 numInputs, functionName,
                                 inputType, implementationName,
                                 outputType, headerFile,
                                 genCallback, genFileName)

Arguments

hTable

Handle to a TFL table previously returned by hTable = RTW.TflTable.

priority

Positive integer specifying the function entry's search priority, 0-100, relative to other entries of the same function name and conceptual argument list within this table. Highest priority is 0, and lowest priority is 100. If the table provides two implementations for a function, the implementation with the higher priority will shadow the one with the lower priority.

numInputs

Positive integer specifying the number of input arguments.

functionName

String specifying the name of the function to be replaced. The name must match one of the functions supported for replacement:

`abs`	`ceil`	`floor`	`sinh`
`acos`	`cos`	`log`	`sqrt`
`asin`	`cosh`	`log10`	`tan`
`atan`	`exp`	`sin`	`tanh`

inputType

String specifying the data type of the input arguments, for example, 'double'. (This function requires that all input arguments are of the same type.)

implementationName

String specifying the name of your implementation. For example, if functionName is 'sqrt', implementationName can be 'sqrt' or a different name of your choosing.

outputType

String specifying the data type of the return argument, for example, 'double'.

headerFile

String specifying the header file in which the implementation function is declared, for example, '<math.h>'.

genCallback

String specifying '' or 'RTW.copyFileToBuildDir'. If you specify 'RTW.copyFileToBuildDir', and if this function entry is matched and used, the function RTW.copyFileToBuildDir will be called after code generation to copy additional header, source, or object files that you have specified for this function entry to the build directory. For more information, see Specifying Build Information for Function Replacements in the Real-Time Workshop^® Embedded Coder™ documentation.

genFileName

String specifying ''. (This argument is for use only by MathWorks developers.)

Returns

Handle to the created TFL function entry.

Description

The registerCFunctionEntry function provides a quick way to create and register a TFL function entry. This function can be used only if your TFL function entry meets the following conditions:

All input arguments are of the same type.
All input argument names and the return argument name follow the default Simulink^® naming convention:
- For input argument names, u1, u2, ..., un
- For return argument, y1

Example

In the following example, the registerCFunctionEntry function is used to create a function entry for sqrt in a TFL table.