Main Content

addInterface

Create named interface in interface dictionary

Description

example

interface = addInterface(dictionary,name) adds a named interface to a specified interface dictionary.

example

interface = addInterface(dictionary,name,'SimulinkBus',busObject) constructs an interface that mirrors an existing Simulink® bus object.

Examples

collapse all

Add an interface 'newInterface' to the specified data dictionary and then create a model, link the dictionary, and view the interface editor.

Create a data dictionary and add an interface.

dictionary = systemcomposer.createDictionary('new_dictionary.sldd');
interface = addInterface(dictionary,'newInterface')

Create a new model, link the data dictionary, and open the interface editor.

arch = systemcomposer.createModel('newModel',true);
linkDictionary(arch,'new_dictionary.sldd');

Add a named interface that mirrors an existing Simulink bus object to a specified dictionary. Create a model, link the dictionary, and view the interface editor.

Create a dictionary, create a Simulink bus object, populate the bus object with two elements, and add the named interface that mirrors the Simulink bus object to the dictionary.

dictionary = systemcomposer.createDictionary('new_dictionary.sldd');

% Create the Simulink bus object and populate it with elements
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',1);
linkDictionary(arch,'new_dictionary.sldd');

Input Arguments

collapse all

Data dictionary attached to architecture model, specified as a systemcomposer.interface.Dictionary object. This is 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 one that carries interface definitions. For information on how to create a dictionary, see createDictionary.

Name of new interface, specified as a character vector.

Data Types: char

Simulink bus object that new interface mirrors where the interface is already defined, specified as a Simulink bus object.

Output Arguments

collapse all

New interface object, returned as a systemcomposer.interface.SignalInterface object.

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
interfaceAn 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 elementAn 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 dictionaryAn 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.
adapterAn 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

Introduced in R2019a