setInport
Configure root-level inports for code and calibration file (a2l) generation
Since R2020b
Description
setInport(
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.myCodeMappingObj
,inport
,Name,Value
)
Examples
Configure Storage Class for Root-Level Inports in Model to Model default
In the model code mappings for model
ConfigurationRapidPrototypingInterface
, 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");
Configure Storage Class and Storage Class Properties for Root Inport Block
In the model code mappings for model
ConfigurationRapidPrototypingInterface
, 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");
Configure Calibration Properties for Root-Level Inports
In the model code mappings for model
ConfigurationRapidPrototypingInterface
, 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
myCodeMappingObj
— Code mapping object
CodeMapping
object
Code mapping object (model code mappings) returned by a call to function
coder.mapping.api.get
.
Example: myCM
inport
— Name, path, or handle of root-level inport
character vector | string scalar | block handle | cell array of character vectors | cell array of string scalars | cell array of handles
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
Specify optional pairs of arguments as
Name1=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"
StorageClass
— Name of storage class
Auto
| Bitfield
| Dictionary default
| ExportedGlobal
| ExportToFile
| GetSet
| ImportedExtern
| ImportedExternPointer
| ImportFromFile
| Localizable
| Model default
| Struct
| Volatile
| storage class name
Storage class to set for the specified root Inport block. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. See Configure Root-Level Inport Blocks for C Code Generation.
Identifier
— Name of variable
character vector | string scalar
Name for the variable that represents the inport 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, 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
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
.
Data Types: char
| string
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.
Export
— Enable or disable generation of the inport to calibration file (a2l)
true
(default) | false
Enable this property to generate the inport to calibration file (a2l).
BitMask
— Extract single bits from the inport value
hexadecimal value
Mask value in hexadecimal format to extract single bits from the inport during calibration. This property is applicable only for integers.
Data Types: hexadecimal
CalibrationAccess
— Enable or disable calibration of the inport
NoCalibration
(default) | Calibration
Select Calibration
for the inport to enable the calibration.
Select NoCalibration
to view the value of the inport 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 inport
character vector | string scalar
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
Format
— Display format of the inport 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 inport.
ReceiverService
— Name of receiver service interface
Dictionary default
(default) | character vector | string scalar
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
See Also
coder.mapping.api.CodeMapping
| coder.mapping.api.get
| find
| getDataDefault
| getInport
| setDataDefault
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)