setSignal

Configure block signal data for code and calibration file (a2l) generation

Since R2020b

Syntax

setSignal(myCodeMappingObj,portHandle,Name,Value)

Description

setSignal(myCodeMappingObj,portHandle,Name,Value) configures signals specified by block output ports for code and calibration file (a2l) generation. Use this function to map specified block output ports to the storage class and storage class property settings that the code generator uses to produce C code. Or, set the calibration access for the corresponding signal data.

This function does not apply to signals that originate from root-level Inport blocks. For signals that originate from root-level Inport blocks, see setInport.

Examples

Configure Storage Class for Block Output Signals

In the model code mappings for model ConfigurationRapidPrototypingInterface, set the storage class for output signals of lookup table blocks Table1 and Table2D to ExportedGlobal. After creating the object cm by calling function coder.mapping.api.get, get handles to the output ports for lookup table blocks. Set the storage class for the output signals by calling setSignal.

openExample("ConfigurationRapidPrototypingInterface");
cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
lut1_ports = get_param("ConfigurationRapidPrototypingInterface/Table1","PortHandles");
lut2_ports = get_param("ConfigurationRapidPrototypingInterface/Table2","PortHandles");
lut1_outPort = lut1_ports.Outport;
lut2_outPort = lut2_ports.Outport;
addSignal(cm,[lut1_outPort,lut2_outPort]);
setSignal(cm,[lut1_outPort,lut2_outPort],StorageClass="ExportedGlobal");

Configure Storage Class for Signal Data in Model Code Mappings to Model default

In the model code mappings for model ConfigurationRapidPrototypingInterface, set the storage class for block output signals to Model default. After creating the object cm by calling function coder.mapping.api.get, get the port handles of the signal data in the code mappings. Set the storage class for the signals by calling setSignal.

openExample("ConfigurationRapidPrototypingInterface");
cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
portHandles = find(cm,"Signals")
setSignal(cm,portHandles,StorageClass="Model default");

Configure Code Identifiers for Block Output Signals

In the model code mappings for model ConfigurationRapidPrototypingInterface, set the code identifiers for output signals of lookup table blocks Table1 and Table2 to dout_Table1 and dout_Table2. After creating the object cm by calling function coder.mapping.api.get, get handles to the output ports for lookup table blocks. Set the code identifiers for the output signals by calling setSignal.

openExample("ConfigurationRapidPrototypingInterface");
cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
lut1_ports = get_param("ConfigurationRapidPrototypingInterface/Table1","PortHandles");
lut2_ports = get_param("ConfigurationRapidPrototypingInterface/Table2","PortHandles");
lut1_outPort = lut1_ports.Outport;
lut2_outPort = lut2_ports.Outport;
addSignal(cm,[lut1_outPort,lut2_outPort]);
setSignal(cm,lut1_outPort,Identifier="dout_Table1D");
setSignal(cm,lut2_outPort,Identifier="dout_Table2D");

Configure Calibration Properties for Signal

In the model code mappings for model ConfigurationRapidPrototypingInterface, configure the calibration properties for signal Signal_1.

openExample("ConfigurationRapidPrototypingInterface");
cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
lut1_ports = get_param("ConfigurationRapidPrototypingInterface/Table1","PortHandles");
lut1_outPort = lut1_ports.Outport;
addSignal(cm,lut1_outPort);
Signal_1 = find(cm,"Signal");
setSignal(cm,Signal_1,Export=true);
setSignal(cm,Signal_1,CalibrationAccess="NoCalibration");
setSignal(cm,Signal_1,CompuMethod="CM_Signal_1");
setSignal(cm,Signal_1,DisplayIdentifier="Signal_display_name");
setSignal(cm,Signal_1,Format="%4.2");

Input Arguments

myCodeMappingObj — Code mapping object

CodeMapping object

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

Example: myCM

portHandle — Output port handle of signal source block

port handle | array of port handles

Signal to add to the code mappings, specified as a handle of an output port of the signal's source block. To specify multiple port handles, use an array.

Example: portHandle

Data Types: port_handle | array

Name-Value Arguments

Example: StorageClass="ExportedGlobal"

Specify 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.

StorageClass — Name of storage class

Auto | Bitfield | Dictionary default | ExportedGlobal | ExportToFile | FileScope | GetSet | ImportedExtern | ImportedExternPointer | ImportFromFile | Localizable | Model default | Struct | Volatile | storage class name

Storage class to set for the specified signals. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. See Configure Signal Data for C Code Generation.

Identifier — Name of variable

character vector | string scalar

Name for the variable that represents the signal data in the generated code.

Data Types: char | string

DefinitionFile — C source file

character vector | string scalar

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

Data Types: char | string

GetFunction — Name of get function

character vector | string scalar

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

Data Types: char | string

HeaderFile — C header file

character vector | string scalar

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

Data Types: char | string

Owner — Owner of global data

character vector | string scalar

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

Data Types: char | string

PreserveDimensions — Boolean flag indicating whether to preserve dimensions of multidimensional arrays

True | False

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

Data Types: logical

SetFunction — Name of set function

character string | string scalar

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

Data Types: char | string

StructName — Name of structure

character vector | string scalar

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.

storageClassPropertyName — Value of storage class property

depends on property definition

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

Data Types: char | string

Export — Enable or disable generation of the signal to calibration file (a2l)

true (default) | false

Enable this property to generate the signal to calibration file (a2l).

BitMask — Extract single bits from the signal value

hexadecimal value

Mask value in hexadecimal format to extract single bits from the signal during calibration. This property is applicable only for integers.

Data Types: hexadecimal

CalibrationAccess — Enable or disable calibration of the signal

NoCalibration (default) | Calibration

Select Calibration for the signal to enable the calibration. Select NoCalibration to view the value of the signal and disable the calibration.

CompuMethod — Name of conversion method

character vector | string scalar

Name of the method for converting the ECU-internal value to a physical value for easy readability.

Data Types: char | string

DisplayIdentifier — Display name of the signal

character vector | string scalar

Optional display name of the signal for the measurement purpose in the calibration tool, which is different than the signal name in the Simulink model.

Data Types: char | string

Format — Display format of the signal value

%[length].[layout]

Special display format to be specified for measurement in the calibration tool. This format specification overrules the display format specified in CompuMethod of the signal.

MeasurementService — Name of measurement service interface

Dictionary default (default) | character vector | string scalar

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, you must attach an Embedded Coder Dictionary that defines a service interface configuration to the model. For more information, see Configure Measurement Service Interfaces for Signals, States, and Data Stores.

Data Types: char | string

Version History

Introduced in R2020b