Main Content

getInterfaceNames

Get interface names in Architectural Data section of Simulink data dictionary

Since R2023b

collapse all in page

    Syntax

    interfaceNames = getInterfaceNames(archDataObj)
    interfaceNames = getInterfaceNames(archDataObj,LookInsideDictReferences=tf)

    Description

    interfaceNames = getInterfaceNames(archDataObj) returns a cell array of the interface names in archDataObj, the Architectural Data section of a data dictionary.

    example

    interfaceNames = getInterfaceNames(archDataObj,LookInsideDictReferences=tf) returns interface names in the top data dictionary only, or in the top data dictionary and in referenced data dictionaries.

    example

    Examples

    collapse all

    To get a cell array of the interface names in the data dictionary, use the getInterfaceNames 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.

    myInterfaceNames = getInterfaceNames(archDataObj)
    myInterfaceNames =

  1×2 cell array

    {'DataInterface'}    {'DataInterface2'}

    Input Arguments

    collapse all

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

    Flag to list constants in referenced data dictionaries in the returned cell array, specified as one of these values:

    • true — Interfaces in the referenced data dictionaries will be included in the returned cell array.

    • false — Interfaces in the referenced data dictionaries will not be included in the returned cell array.

    Example: true

    Output Arguments

    collapse all

    Interface names in the Interfaces property array of archDataObj,returned as a cell array of character vectors.

    Example: {'DataInterface'} {'DataInterface2'}

    Example: {'PhysicalInterface'} {'ServiceInterface'} {'DataInterface'}

    Version History

    Introduced in R2023b

    See Also

    Objects

    Functions

    Topics