getInterface

Get interface object for interface in Architectural Data section of Simulink data dictionary

Since R2023b

Syntax

interfaceObj = getInterface(archDataObj,interfaceName)

Description

interfaceObj = getInterface(archDataObj,interfaceName) returns the interface object that represents the interface specified by interfaceName in archDataObj, the Architectural Data section of the data dictionary.

Examples

Get Interface Object from Architectural Data Section of Simulink Data Dictionary

To get the interface object that represents the an interface in a data dictionary, use the getInterface function. For an example that shows more of the workflow for related functions, see Create Architectural Data Object and Use It to Configure Architectural Data.

myInterfaceObj = getInterface(archDataObj,"DataInterface")

myInterfaceObj = 

  DataInterface with properties:

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

Input Arguments

archDataObj — Architectural data object

Simulink.dictionary.ArchitecturalData object

Architectural Data object, specified as a Simulink.dictionary.ArchitecturalData object.

interfaceName — Interfaces definition name

character vector | string scalar

interfaceName definition name in Interfaces property array of archDataObj, specified as a character vector or string scalar.

Example: "DataInterface"

Output Arguments

interfaceObj — Interface object

DataInterface object | ServiceInterface object | PhysicalInterface object

Interface object, returned as a Simulink.dictionary.archdata.DataInterface, Simulink.dictionary.archdata.ServiceInterface object, or Simulink.dictionary.archdata.PhysicalInterface object.

Version History

Introduced in R2023b