Simulink.dictionary.archdata.DataInterface

Data interface in Architectural Data section of Simulink data dictionary

Since R2023b

Description

Data interfaces represent information that is shared through a connector and enters or exits a component through a port. Data interfaces are composed of data elements that describe the structure of the transmitted data.

Creation

To create a Simulink.dictionary.archdata.DataInterface object, add a data interface to an existing Simulink.dictionary.ArchitecturalData object using the addDataInterface function.

dataInterfaceObj = addDataInterface(archDataObj,"DataInterface")

dataInterfaceObj = 

  DataInterface with properties:

           Name: 'DataInterface'
    Description: ''
       Elements: [0×0 Simulink.dictionary.archdata.DataElement]
          Owner: [1×1 Simulink.dictionary.ArchitecturalData]

Properties

CppNamespace — Individual C++ namespace of data interface

character vector | string scalar

Specify the C++ namespace for the data interface. When this property is specified, the generated C++ code places the definition of the data interface within the specified namespace. If no namespace is specified, the definition of the data interface is placed in the global namespace.

This property requires an Embedded Coder^® license.

Example: myCompany::engine

Data Types: char | string

DataScope — Data type definition behavior in generated code

'Auto' (default) | 'Imported' | 'Exported'

Data type definition behavior in generated code, specified as 'Auto', 'Imported', or 'Exported'. The table describes the behavior of generated code for each value.

Value	Action
'Auto' (default)	If you do not specify the property HeaderFile, export the data type definition to model_types.h, where model is the model name. If you specify HeaderFile, import the data type definition from the specified header file.
'Exported'	Export the data type definition to a separate header file. If you do not specify the property HeaderFile, the header file name defaults to type.h, where type is the data type name.
'Imported'	Import the data type definition to a separate header file. If you do not specify the property HeaderFile, the header file name defaults to types.h, where type is the data type name.

Description — Description of data interface

'' (default) | character vector | string scalar

Description of the data interface, specified as a character vector or string scalar.

Data Types: char | string

Elements — Elements belonging to Architectural Data object

array of Simulink.dictionary.archdata.DataElement objects

Elements belonging to the Architectural Data object, specified as an array of Simulink.dictionary.archdata.DataElement objects.

HeaderFile — Name of header file defining data interfaces in generated code

'' (default) | character vector

Name of the header file that defines the enumerated data type in generated code, specified as a character vector. Use a .h extension to specify the file name.

If you do not specify HeaderFile, generated code uses a default header file name that depends on the value of the DataScope property.

Example: 'myTypeIncludeFile.h'

Data Types: char

Name — Name of data interface

character vector | string scalar

Name of the data interface, specified as a character vector or string scalar.

Data Types: char | string

Owner — Architectural Data object of data dictionary containing data interface

Simulink.dictionary.ArchitecturalData object

Architectural Data object of the data dictionary containing the data interface, specified as a Simulink.dictionary.ArchitecturalData object.

Object Functions

addElement	Add data element to data interface
destroy	Delete data element and remove from data interface
getElement	Get data element from data interface
removeElement	Remove data element from data interface
show	View architectural data of Simulink data dictionary in Architectural Data Editor

Examples

Add and Remove Data Elements from Data Interface

This example shows how to add, get, and remove data elements from a data interface.

Open an existing data dictionary. This creates a Simulink.dictionary.ArchitecturalData object, archDataObj.

archDataObj = Simulink.dictionary.archdata.open("MyInterfaces.sldd")

archDataObj = 

  ArchitecturalData with properties:

    DictionaryFileName: 'MyInterfaces.sldd'
            Interfaces: [1×1 Simulink.dictionary.archdata.DataInterface]
             DataTypes: [1×2 Simulink.dictionary.archdata.DataType]
             Constants: [1×1 Simulink.dictionary.archdata.Constant]

The archDataObj contains a data interface.

interfaceObj = getInterface(archDataObj,"DataInterface")

interfaceObj = 

  DataInterface with properties:

           Name: 'DataInterface'
    Description: ''
       Elements: [1×2 Simulink.dictionary.archdata.DataElement]
          Owner: [1×1 Simulink.dictionary.ArchitecturalData]

Data interfaces are composed of data elements that describe parts of a data interface. This interface definition contains two data elements.

interfaceObj.Elements(1)

ans = 

  DataElement with properties:

           Name: 'Element1'
           Type: [1×1 Simulink.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1×1 Simulink.dictionary.archdata.DataInterface]

interfaceObj.Elements(2)

ans = 

  DataElement with properties:

           Name: 'Element2'
           Type: [1×1 Simulink.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1×1 Simulink.dictionary.archdata.DataInterface]

Use the addElement function to add a new data element to the data interface.

dataElem3 = addElement(interfaceObj,"Element3")

dataElem3 = 

  DataElement with properties:

           Name: 'Element3'
           Type: [1×1 Simulink.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1×1 Simulink.dictionary.archdata.DataInterface]

You can get an existing data element using the getElement function.

dataElem3 = getElement(interfaceObj,"Element3")

dataElem3 = 

  DataElement with properties:

           Name: 'Element3'
           Type: [1×1 Simulink.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1×1 Simulink.dictionary.archdata.DataInterface]

Remove a data element from an interface using the removeElement function.

removeElement(interfaceObj,"Element3")

Limitations

• Data interfaces cannot have elements that are typed by more than one interface when using an AUTOSAR platform mapping.

Version History

Introduced in R2023b

R2025a: Specify architectural data namespaces in C++ generated code

Starting in R2025a, you can specify the individual namespace for Simulink.dictionary.archdata.DataInterface objects in generated C++ code by setting the CppNamespace property of the object.