Simulink.interface.Dictionary

Manage interface dictionary

Since R2022b

Description

The Simulink.interface.Dictionary object provides methods that help you manage the interface dictionary.

Creation

To create a Simulink interface dictionary and return an object representing the dictionary, use the Simulink.interface.dictionary.create function.

dictName = 'MyInterfaces.sldd';
dictAPI = Simulink.interface.dictionary.create(dictName);

If you already created an interface dictionary, you can create a Simulink.interface.dictionary object to represent the existing dictionary by using the Simulink.interface.dictionary.open function.

dictAPI = Simulink.interface.dictionary.open('MyInterfaces.sldd');

Properties

DataTypes — Data types defined in dictionary

array of DataType objects

Data types defined in dictionary, specified as an array of DataType objects with properties: Name and Owner.

DictionaryFileName — File name associated with dictionary

character vector

File name of SLDD file associated with the dictionary.

Interfaces — Interfaces defined in dictionary

array of interface objects

Interfaces defined in dictionary, specified as an array of DataInterface and ServiceInterface objects with properties: Name, Description, Elements, and Owner.

Object Functions

addAliasType	Add Simulink alias type to Simulink interface dictionary
addDataInterface	Add data interface to Simulink interface dictionary
addEnumType	Add enumerated type to Simulink interface dictionary
addNumericType	Add Simulink numeric type to Simulink interface dictionary
addPlatformMapping	Add AUTOSAR Classic mapping to Simulink interface dictionary
addReference	Add Simulink interface dictionary reference to another interface dictionary
addServiceInterface	Add service interface to Simulink interface dictionary
addStructType	Add structure type represented by Simulink.Bus in Simulink interface dictionary
addValueType	Add value type to Simulink interface dictionary
close	Close open connections to Simulink interface dictionary
discardChanges	Discard changes to interface dictionary
findEntryByName	Get corresponding object for specified entry name in interface dictionary
getDataType	Get data type in Simulink interface dictionary
getDataTypeNames	Get names of data types in Simulink interface dictionary
getInterface	Get interface object for interface in Simulink interface dictionary
getInterfaceNames	Get cell array of interface names in Simulink interface dictionary
getPlatformMapping	Get platform mapping object for platform in dictionary
getReferences	Get cell array of names of interface dictionaries that are referenced by another interface dictionary
importFromBaseWorkspace	Import Simulink object definitions
importFromFile	Import Simulink object definitions
isDirty	Check whether there are unsaved changes in Simulink interface dictionary
removeDataType	Remove data type from Simulink interface dictionary
removeInterface	Remove interface from Simulink interface dictionary
removeReference	Remove Simulink interface dictionary reference from another interface dictionary
save	Save changes to Simulink interface dictionary
show	View contents of Simulink interface dictionary in standalone viewer
showChanges	View changes to contents of Simulink interface dictionary in comparison viewer

Examples

Create and Configure Interface Dictionary

This example creates a Simulink.interface.dictionary object and configures the dictionary contents. This example also shows how to manage AUTOSAR Classic platform-related elements.

Create an interface dictionary.

dictName = 'MyInterfaces.sldd';
dictAPI = Simulink.interface.dictionary.create(dictName);

Add data types.

% Alias Types
myAliasType1 = addAliasType(dictAPI,'aliasType',BaseType='single');
myAliasType1.Name = 'myAliasType1';
myAliasType1.BaseType = 'fixdt(1,32,16)';
 
myAliasType2 = addAliasType(dictAPI,'myAliasType2');
% can also use interface dict type objs
myAliasType2.BaseType = myAliasType1;
 
% Enum Type
myEnumType1 = addEnumType(dictAPI,'myColor');
myEnumType1.addEnumeral('RED','0','Solid Red');
myEnumType1.addEnumeral('BLUE','1','Solid Blue');
myEnumType1.DefaultValue = 'BLUE';
myEnumType1.Description = 'I am a Simulink Enumeration';
myEnumType1.StorageType = 'int16';
 
% set base type of an alias type to be this enum object
myAliasType3 = addAliasType(dictAPI,'myAliasType3');
myAliasType3.BaseType = myEnumType1;
 
% Value Type
myValueType1 = addValueType(dictAPI,'myValueType1');
myValueType1.DataType = 'int32';
myValueType1.Dimensions = '[2 3]';
myValueType1.Description = 'I am a Simulink ValueType';
myValueType1.DataType = myEnumType1; % can also use interface dict type objs
 
% Struct Type
myStructType1 = addStructType(dictAPI,'myStructType1');
structElement1 = myStructType1.addElement('Element1');
structElement1.Type.DataType = 'single';
structElement1.Type.Dimensions = '3';
structElement2 = myStructType1.addElement('Element2');
structElement2.Type = myValueType1;
% or
structElement2.Type = 'ValueType: myValueType1';
 
% Nested Struct Type
myStructType2 = addStructType(dictAPI,'myStructType2');
myStructType2.Description = 'I am a nested structure';
structElement = myStructType2.addElement('Element');
structElement.Dimensions = '5';
structElement.Type = myStructType1;
% or
structElement.Type = 'Bus: myStructType1';

Add interfaces and configure design data on data elements.

dataInterface1 = addDataInterface(dictAPI,'DataInterface');
 
dataElm1 = addElement(dataInterface1,'DE1');
dataElm1.Type = myValueType1;
 
dataElm2 = addElement(dataInterface1,'DE2');
dataElm2.Type = myStructType2;
dataElm2.Dimensions = '4';
dataElm2.Description = 'I am a data element with datatype = array of struct type';
 
% data element with owned type
dataElm3 = addElement(dataInterface1,'DE3');
dataElm3.Type.DataType = 'single';
dataElm3.Type.Dimensions = '10';
dataElm3.Type.Minimum = '-5';
 
dataInterface2 = addDataInterface(dictAPI,'DataInterface2');

Add AUTOSAR Classic mapping.

platformMapping = addPlatformMapping(dictAPI,'AUTOSARClassic');

Set AUTOSAR communication interface and package properties.

setPlatformProperty(platformMapping,dataInterface1,...
    Package='/Interface2',InterfaceKind='NvDataInterface');

Get the platform-specific properties.

[pNames, pValues] = getPlatformProperties(platformMapping,dataInterface1);

Manage AUTOSAR Classic platform-related elements, SwAddrMethod and calibration properties. These elements do not have mapping to Simulink.

arObj = autosar.api.getAUTOSARProperties(dictName);
addPackageableElement(arObj,'SwAddrMethod', ... 
    '/SwAddressMethods','VAR1','SectionType','Var');
setPlatformProperty(platformMapping,dataElm1, ...
    SwAddrMethod='VAR1',SwCalibrationAccess='ReadWrite',... 
     DisplayFormat='%.3f');

Version History

Introduced in R2022b

R2023b: Simulink.interface.Dictionary object replaced by Simulink.dictionary.ArchitecturalData object

Starting in R2023b, use the Simulink.dictionary.ArchitecturalData object to programmatically manage architectural data instead of the Simulink.interface.Dictionary object.