Simulink.interface.dictionary.DataElement

Data element of data interface

Since R2022b

Description

A data element describes a portion of a data interface, such as the structure of the transmitted data or other decomposition of the interface.

Creation

To create a Simulink.interface.dictionary.DataElement object, add a data element to an existing Simulink.interface.dictionary.DataInterface object using the addElement function.

dataElementObj = addElement(dataInterfaceObj,"element")

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

Properties

Name — Name of data element

character vector | string scalar

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

Data Types: char | string

Type — Type of data element

Simulink.interface.dictionary.ValueType object

Type of the data element, specified as a Simulink.interface.dictionary.ValueType object.

Description — Description of data element

character vector | string scalar

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

Data Types: char | string

Dimensions — Dimensions of data element

character vector

Dimensions of data element, specified as a character vector representing a two element vector containing the dimensions of the element.

Data Types: char

Owner — Data interface containing the data element

Simulink.interface.dictionary.DataInterface object

Simulink.interface.dictionary.DataInterface object that contains the data element.

Object Functions

destroy	Destroy data element and remove from data interface
show	Show data element in Interface Editor

Examples

Add and Remove Data Elements From a Data Interface

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

Open an existing interface dictionary. This creates a Simulink.interface.Dictionary object, interfaceDictObj.

interfaceDictObj = Simulink.interface.dictionary.open('myInterfaceDict.sldd')

interfaceDictObj = 
  Dictionary with properties:

    DictionaryFileName: 'myInterfaceDict.sldd'
            Interfaces: [1x1 Simulink.interface.dictionary.DataInterface]
             DataTypes: [0x0 Simulink.interface.dictionary.DataType]

This interface dictionary contains one data interface definition.

interfaceObj = interfaceDictObj.Interfaces

interfaceObj = 
  DataInterface with properties:

           Name: 'interface1'
    Description: ''
       Elements: [1x2 Simulink.interface.dictionary.DataElement]
          Owner: [1x1 Simulink.interface.Dictionary]

Data interfaces are composed of data elements which describe portions of a data interface. This interface definition contains two data elements.

interfaceObj.Elements(1)

ans = 
  DataElement with properties:

           Name: 'element1'
           Type: [1x1 Simulink.interface.dictionary.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.interface.dictionary.DataInterface]

interfaceObj.Elements(2)

ans = 
  DataElement with properties:

           Name: 'element2'
           Type: [1x1 Simulink.interface.dictionary.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.interface.dictionary.DataInterface]

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

dataElem1 = addElement(interfaceObj, 'element3')

dataElem1 = 
  DataElement with properties:

           Name: 'element3'
           Type: [1x1 Simulink.interface.dictionary.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.interface.dictionary.DataInterface]

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

dataElem3 = getElement(interfaceObj, 'element3')

dataElem3 = 
  DataElement with properties:

           Name: 'element3'
           Type: [1x1 Simulink.interface.dictionary.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.interface.dictionary.DataInterface]

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

removeElement(interfaceObj, 'element3')

Version History

Introduced in R2022b