getInterface

Get object for named interface in interface dictionary

Syntax

interface = getInterface(dictionary,name)

interface = getInterface(dictionary,name,Name=Value)

Description

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

interface = getInterface(dictionary,name,Name=Value) gets the object for a named interface in the interface dictionary with additional options.

Examples

Add Data Interface and Get Data Interface

Add a data interface newInterface to the interface dictionary of the model. Obtain the data interface object. Confirm by opening the Interface Editor.

arch = systemcomposer.createModel("newModel");
addInterface(arch.InterfaceDictionary,"newInterface");
interface = getInterface(arch.InterfaceDictionary,"newInterface")

interface = 

  DataInterface with properties:

          Owner: [1×1 systemcomposer.interface.Dictionary]
           Name: 'newInterface'
       Elements: [0×0 systemcomposer.interface.DataElement]
          Model: [1×1 systemcomposer.arch.Model]
           UUID: '205cdd2f-12bc-4bbb-a4a7-75d0ab18adb8'
    ExternalUID: ''

Add Physical Interface and Get Physical Interface

Add a physical interface newInterface to the interface dictionary of the model. Obtain the physical interface object. Confirm by opening the Interface Editor.

arch = systemcomposer.createModel("newModel");
addPhysicalInterface(arch.InterfaceDictionary,"newInterface");
interface = getInterface(arch.InterfaceDictionary,"newInterface")

interface = 

  PhysicalInterface with properties:

          Owner: [1×1 systemcomposer.interface.Dictionary]
           Name: 'newInterface'
       Elements: [0×0 systemcomposer.interface.PhysicalElement]
          Model: [1×1 systemcomposer.arch.Model]
           UUID: '6110207d-2d6d-470e-9bf5-f0e6f6914685'
    ExternalUID: ''

Input Arguments

dictionary — Data dictionary

dictionary object

Data dictionary, specified as a systemcomposer.interface.Dictionary object. For information on how to create a data dictionary, see createDictionary.

name — Name of interface

character vector | string

Name of interface, specified as a character vector or string.

Example: "newInterface"

Data Types: char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: getInterface(dict,"newInterface",ReferenceDictionary="")

ReferenceDictionary — Reference dictionary

character vector | string

Reference dictionary to search for interfaces, specified as a character vector or string with the .sldd extension. Enter an empty character vector or string to include all referenced dictionaries in the search.

Example: getInterface(dict,"newInterface",ReferenceDictionary="referenceDictionary.sldd")

Data Types: char | string

Output Arguments

interface — Interface

data interface object | physical interface object | service interface object | value type object

Interface, returned as a systemcomposer.interface.DataInterface, systemcomposer.interface.PhysicalInterface, systemcomposer.interface.ServiceInterface, or systemcomposer.ValueType object.

More About

Definitions

Term	Definition	Application	More Information
interface data dictionary	An interface data dictionary is a consolidated list of interfaces and value types in an architecture and where you use them in the architecture.	You can save local interfaces on a System Composer™ model in an interface data dictionary using the Interface Editor. You can reuse data dictionaries between models that need to use a given set of interfaces, elements, and value types. Data dictionaries that you link to models are stored in separate SLDD files.	Manage Interfaces with Data Dictionaries Reference Data Dictionaries
data interface	A data interface defines the kind of information that flows through a port. The same interface can be assigned to multiple ports. A data interface can be composite, meaning that it can include data elements that describe the properties of an interface signal.	Data 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 data interfaces and data elements and store them in an interface data dictionary for reuse between models.	Create Architecture Model with Interfaces and Requirement Links Define Port Interfaces Between Components
data element	A data element describes a portion of an interface, such as a communication message, a calculated or measured parameter, or other decomposition of that interface.	Data interfaces are decomposed into data elements: Pins or wires in a connector or harness. Messages transmitted across a bus. Data structures shared between components.	Create Interfaces Assign Interfaces to Ports
value type	A value type can be used as a port interface to define the atomic piece of data that flows through that port and has a top-level type, dimension, unit, complexity, minimum, maximum, and description.	You can also assign the type of data elements in data interfaces to value types. Add value types to data dictionaries using the Interface Editor so that you can reuse the value types as interfaces or data elements.	Create Value Types as Interfaces
owned interface	An owned interface is an interface that is local to a specific port and not shared in a data dictionary or the model dictionary.	Create an owned interface to represent a value type or data interface that is local to a port.	Define Owned Interfaces Local to Ports
adapter	An adapter connects two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay, rate transition, or merge. You can also use an adapter for bus creation. Use the Adapter block to implement an adapter.	With an adapter, you can perform functions on the Interface Adapter dialog box: 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. Apply an interface conversion Merge to merge two or more message or signal lines. When output interfaces are undefined, you can use input interfaces in bus creation mode to author owned output interfaces.	Interface Adapter Adapter

Version History

Introduced in R2019a