Simulink.dictionary.archdata.StructElement

Struct element of a struct type

Since R2023b

Description

A struct element of a struct type, represented by a Simulink.dictionary.archdata.StructType object.

Creation

To create a Simulink.dictionary.archdata.StructElement object, add a struct element to an existing StructType object using the addElement function.

StructElemObj1 = addElement(StructTypeObj,"myStructElem1");

Properties

Name — Struct element name

character vector | string scalar

Struct element name, specified as a character vector or string scalar.

Data Types: char | string

Type — Type of struct element

Simulink.dictionary.archdata.ValueType object

Type of struct element, specified as a Simulink.dictionary.archdata.ValueType object.

Description — Description of struct element

character vector | string scalar

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

Data Types: char | string

Dimensions — Dimensions of struct element

character vector | string scalar

Dimensions of the struct element, specified as a character vector or string scalar representing a two-element vector containing the dimensions of the element.

Data Types: char

Owner — Struct type object containing the struct element

Simulink.dictionary.archdata.StructType object

Struct type object containing the struct element, specified as a Simulink.dictionary.archdata.StructType object.

Object Functions

moveToDictionary	Move architectural data of Simulink data dictionary to another data dictionary
moveToDesignData	Move interfaces, data types, and constants in Architectural Data section of Simulink data dictionary to design data
show	View architectural data of Simulink data dictionary in Architectural Data Editor
destroy	Delete data element and remove from data interface

Examples

Configure Struct Elements of Struct Type

To configure struct elements of a struct type, use the addElement, getElement, and removeElement functions.

In this example, the dictionary MyInterfaces.sldd contains one struct type.

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

archDataObj = 

  ArchitecturalData with properties:

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

Get the struct type object using the getDataType function. The struct type object contains two struct element objects.

structTypeObj = getDataType(archDataObj,"structType1")

structTypeObj = 

  StructType with properties:

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

To create a struct element object and add it to the struct type, use the addElement function.

structElemObj3 = addElement(structTypeObj,"structElement3")

structElemObj3 = 

  StructElement with properties:

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

To access an existing function element, use the getElement function.

structElemObj2 = getElement(structTypeObj,"structElement2")

structElemObj2 = 

  StructElement with properties:

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

To remove a struct element from a struct type, use the removeElement function.

removeElement(structTypeObj,"structElement1")

The struct type object now contains only two struct elements, structElement2 and structElement3

structTypeObj.Elements(1)

ans = 

  StructElement with properties:

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

structTypeObj.Elements(2)

ans = 

  StructElement with properties:

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

Version History

Introduced in R2023b