Main Content

getInterface

Get object for named interface in interface dictionary

Description

example

interface = getInterface(dictionary,name) gets the object for a named interface in the interface dictionary.

Examples

collapse all

Add an interface 'newInterface' to the interface dictionary of the model. Obtain the interface object.

addInterface(arch.InterfaceDictionary,'newInterface')
interface = getInterface(arch.InterfaceDictionary,'newInterface')
interface = 
  SignalInterface with properties:
     Dictionary: [1×1 systemcomposer.interface.Dictionary]
           Name: 'newInterface'
       Elements: [0×0 systemcomposer.interface.SignalElement]
           UUID: '438b5004-6cab-40eb-955b-37e0df5a914f'
    ExternalUID: ''

Input Arguments

collapse all

Data dictionary, specified as a systemcomposer.interface.Dictionary object. This is the data dictionary attached to the model. It could be the local dictionary of the model or an external data dictionary.

Name of interface, specified as a character vector.

Data Types: char

Output Arguments

collapse all

Object for named interface, returned as a systemcomposer.interface.SignalInterface object.

Introduced in R2019a