getInterface

Get object for named interface in interface dictionary

Syntax

interface = getInterface(dictionary,name)

Description

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

Examples

Add Interface and Get Interface

Add an interface 'newInterface' to the interface dictionary of the model. Obtain the interface object. Confirm by opening the interface editor.

arch = systemcomposer.createModel('newModel',true);
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

dictionary — Data dictionary

dictionary object

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 — Name of interface

character vector

Name of interface, specified as a character vector.

Data Types: char

Output Arguments

interface — Object for named interface

signal interface object

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

More About

Definitions

Term	Definition	Application	More Information
interface	An interface defines the kind of information that flows through a port. The same interface can be assigned to multiple ports. An interface can be composite, meaning that it can include elements that describe the properties of an interface signal.	Interfaces represent the information that is shared through a connector and enters or exits a component through a port. Use the Interface Editor to create and manage interfaces and interface elements and store them in an interface data dictionary for reuse between models.	Define Interfaces
interface element	An interface element describes a portion of an interface, such as a communication message, a calculated or measured parameter, or other decomposition of that interface.	Interface elements describe the decompositions of an interface: Pins or wires in a connector or harness. Messages transmitted across a bus. Data structures shared between components.	Assign Interfaces to Ports
interface dictionary	An interface data dictionary is a consolidated list of all the interfaces in an architecture and where they are used. Local interfaces on a System Composer™ model can be saved in an interface data dictionary using the Interface Editor.	Interface dictionaries can be reused between models that need to use a given set of interfaces and interface elements. Data dictionaries are stored in separate .sldd files.	Save, Link, and Delete Interfaces Reference Data Dictionaries
adapter	An adapter helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can also act as a unit delay or rate transition.	With an adapter, you can perform three functions on the Interface Adapter dialog: Create and edit mappings between input and output interfaces. Apply an interface conversion UnitDelay to break an algebraic loop. Apply an interface conversion RateTransition to reconcile different sample time rates for reference models.	Interface Adapter