setInport - Configure root-level inports for code and calibration file (a2l)

  generation - MATLAB ([original](https://in.mathworks.com/help/ecoder/ref/setinport.html)) ([raw](?raw))

Configure root-level inports for code and calibration file (a2l) generation

Since R2020b

Syntax

Description

setInport([myCodeMappingObj](#mw%5F5cd16593-97b4-4537-8098-8078ff10989b),[inport](#mw%5F7a6a53c7-d396-4d5f-a58b-d77d7a045de0),[Name,Value](#namevaluepairarguments)) configures specified root-level Inport blocks for code and calibration file (a2l) generation. For example, use this function to map specified root-level inports to the storage class and storage class property settings that the code generator uses to produce C code for the inports. Or, set the calibration access for the inport.

example

Examples

collapse all

In the model code mappings for modelConfigurationRapidPrototypingInterface, set the storage class for root-level inports throughout the model to Model default.

openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); inBlockHandles = find(cm,"Inports"); setInport(cm,inBlockHandles,StorageClass="Model default");

In the model code mappings for modelConfigurationRapidPrototypingInterface, set the storage class for root-level inport In1 to ExportedGlobal and set the code identifier to input1.

openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); setInport(cm,"In1",StorageClass="ExportedGlobal",Identifier="input1");

In the model code mappings for modelConfigurationRapidPrototypingInterface, set the calibration properties for root-level Inport block In1.

openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); setInport(cm,"In1",Export=true); setInport(cm,"In1",CalibrationAccess="Calibration"); setInport(cm,"In1",CompuMethod="CM_Inport"); setInport(cm,"In1",DisplayIdentifier="inport_display_name"); setInport(cm,"In1",Format="%4.2");

Input Arguments

collapse all

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

Example: myCM

Name, path, or handle of root-level inport to configure. To specify multiple inports, use a cell array.

Example: "In1"

Data Types: char | string | cell

Name-Value Arguments

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

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: StorageClass="ExportedGlobal"

Name for the variable that represents the inport in the generated code.

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

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

Data Types: char | string

Name of the model that owns global data, which is 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 andVolatile.

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 represented in generated code as a multidimensional array. Applies to storage classes ExportToFile,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 andStruct.

Data Types: char | string

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

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

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

Data Types: hexadecimal

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

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

Data Types: char | string

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

Data Types: char | string

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

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, you must attach an Embedded Coder Dictionary that defines a service interface configuration to the model. For more information, see Configure Sender and Receiver Service Interfaces for Model Inports and Outports.

Data Types: char | string

Version History

Introduced in R2020b