Main Content

Simulink.interface.dictionary.DataElement

Data element of data interface

Since R2022b

expand all in page

    In R2023b the Architectural Data section of data dictionaries was introduced. When managing interfaces, data types, constants, and software address methods consider using the Simulink.dictionary.ArchitecturalData programmatic interfaces instead. For more information, see Programmatically Manage AUTOSAR Architectural Data.

    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

    expand all

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

    Data Types: char | string

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

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

    Data Types: char | string

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

    Data Types: char

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

    Object Functions

    destroyDestroy data element and remove from data interface
    showShow 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.

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

      interfaceDictObj = Simulink.interface.dictionary.open('myInterfaceDict.sldd')
      interfaceDictObj = 
  ArchitecturalData with properties:

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

    2. This interface dictionary contains one data interface definition.

      interfaceObj = interfaceDictObj.Interfaces
      interfaceObj = 
  DataInterface with properties:

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

    3. 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.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.dictionary.archdata.DataInterface]


      interfaceObj.Elements(2)
      ans = 
  DataElement with properties:

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

    4. 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.dictionary.archdata.ValueType]
    Description: ''
     Dimensions: '1'
          Owner: [1x1 Simulink.dictionary.archdata.DataInterface]

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

      dataElem3 = getElement(interfaceObj, 'element3')
      dataElem3 = 
  DataElement with properties:

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

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

      removeElement(interfaceObj, 'element3')

    Version History

    Introduced in R2022b

    See Also

    | |