Main Content

addInterface

Create named data interface in interface dictionary

所有的页面崩溃

Syntax

interface = addInterface(dictionary,name)
interface = addInterface(dictionary,name,'SimulinkBus',busObject)

Description

example

interface= addInterface (dictionary,name)adds the data interface specified by namenameto the interface dictionarydictionary.

To remove an interface, use theremoveInterfacefunction.

example

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

Examples

collapse all

Create a data dictionary, then add a data interfacenewInterface.

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

Create a new model and link the data dictionary. Then, open theInterface Editorto view the new interface.

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

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 theInterface Editor.

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

Input Arguments

collapse all

Data dictionary, specified as asystemcomposer.interface.Dictionaryobject. 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, thendictionarymust be the dictionary that carries interface definitions. For information on how to create a dictionary, seecreateDictionary.

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

Simulink bus object that new data interface mirrors, specified as a Simulink bus object.

Output Arguments

collapse all

New data interface, returned as asystemcomposer.interface.DataInterfaceobject.

More About

collapse all

Definitions

Term Definition Application More Information
interface data dictionary

Aninterface data dictionaryis 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 theInterface Editor. Interface dictionaries can be reused between models that need to use a given set of interfaces, elements, and value types. Data dictionaries are stored in separate SLDD files.
data interface

Adata interfacedefines 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 theInterface Editorto create and manage data interfaces and data elements and store them in an interface data dictionary for reuse between models.
data element

Adata elementdescribes 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.
value type

Avalue typecan 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 theInterface Editorso that you can reuse the value types as interfaces or data elements.

 Create Value Types as Interfaces
owned interface

Anowned interface是一个接口,是当地的特定端口nd 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

Anadapterhelps 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 theAdapterblock to implement an adapter.

With an adapter, you can perform functions on theInterface Adapterdialog:

  • Create and edit mappings between input and output interfaces.

  • Apply an interface conversionUnitDelayto break an algebraic loop.

  • Apply an interface conversionRateTransitionto reconcile different sample time rates for reference models.

  • When output interfaces are undefined, you can use input interfaces in bus creation mode to author owned output interfaces.

Version History

Introduced in R2019a

See Also

||||||||

Topics