addInterface
Syntax
Description
adds the data interface specified by name interface
= addInterface(dictionary
,name
)name
to the interface
dictionary dictionary
.
To remove an interface, use the removeInterface
function.
constructs a data interface that mirrors an existing Simulink® bus object.interface
= addInterface(dictionary
,name
,'SimulinkBus',busObject
)
Examples
Add Data Interface
Create a data dictionary, then add a data interface
newInterface
.
dictionary = systemcomposer.createDictionary("new_dictionary.sldd"); interface = addInterface(dictionary,"newInterface")
Create a new model and link the data dictionary. Then, open the Interface Editor to view the new interface.
arch = systemcomposer.createModel("newModel",true); linkDictionary(arch,"new_dictionary.sldd");
Add Simulink Bus Mirrored Data Interface
Create a dictionary, create a Simulink bus object, populate the bus object with two elements, and add the named data interface that mirrors the Simulink bus object to the dictionary.
dictionary = systemcomposer.createDictionary("new_dictionary.sldd"); busObj = Simulink.Bus; elems(1) = Simulink.BusElement; elems(1).Name = 'element_1'; elems(2) = Simulink.BusElement; elems(2).Name = 'element_2'; busObj.Elements = elems; interface = addInterface(dictionary,"newInterface",SimulinkBus=busObj);
Create a new model, link the data dictionary, and open the Interface Editor.
arch = systemcomposer.createModel("newModel",true); linkDictionary(arch,"new_dictionary.sldd");
Input Arguments
dictionary
— Data dictionary
dictionary object
Data dictionary, specified as a systemcomposer.interface.Dictionary
object. You can specify the default
data dictionary that defines local interfaces or an external data dictionary that
carries interface definitions. If the model links to multiple data dictionaries, then
dictionary
must be the dictionary that carries interface
definitions. For information on how to create a dictionary, see createDictionary
.
name
— Name of new data interface
character vector | string
Name of new data interface, specified as a character vector or string. This name must be a valid MATLAB® identifier.
Example: "newInterface"
Data Types: char
| string
busObject
— Simulink bus object that new data interface mirrors
bus object
Simulink bus object that new data interface mirrors, specified as a Simulink bus object.
Output Arguments
interface
— New data interface
data interface object
New data interface, returned as a systemcomposer.interface.DataInterface
object.
More About
Definitions
Term | Definition | Application | More Information |
---|---|---|---|
interface data dictionary | An interface data dictionary is a consolidated list of all the interfaces and value types 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. You can reuse interface dictionaries between models that need to use a given set of interfaces, elements, and value types. Linked data dictionaries are stored in separate SLDD files. | |
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. | |
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:
| |
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 helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay or rate transition. 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:
|
Version History
Introduced in R2019a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)