Author Interfaces in Architecture Models

R2026b

Author and modify architectures using ports and interfaces

In System Composer™, a data interface defines the type, dimensions, units, and structure of the data contained within a port and exchanged between components. You can define shared interfaces or interfaces owned by ports locally that are saved with the model, or you can define interfaces in a data dictionary to be used across models. You can also use the Interface Editor to specify information exchange between components with data interfaces, physical interfaces, and value types.

Blocks

	Component	Add components to architecture model
	Port	Add ports to components in architecture model
	Reference Component	Link to architectural definition or Simulink behavior
	Adapter	Connect components with different interfaces

Classes

`systemcomposer.ValueType`	Value type in System Composer
`systemcomposer.interface.DataInterface`	Data interface
`systemcomposer.interface.DataElement`	Data element in data interface
`systemcomposer.interface.PhysicalDomain`	Physical domain in System Composer
`systemcomposer.interface.PhysicalInterface`	Physical interface
`systemcomposer.interface.PhysicalElement`	Physical element in physical interface
`systemcomposer.interface.Dictionary`	Architectural data of data dictionary of architecture model

Functions

expand all

Value Type Management

`addValueType`	Create named value type in data dictionary
`createInterface`	Create and set owned interface for port
`setName`	Set name for value type, function argument, interface, or element
`setDataType`	Set data type for value type
`setDimensions`	Set dimensions for value type
`setUnits`	Set units for value type
`setComplexity`	Set complexity for value type
`setMinimum`	Set minimum for value type
`setMaximum`	Set maximum for value type
`setDescription`	Set description for value type or interface

Interface Management

`addInterface`	Create named data interface in data dictionary
`moveInterface`	Move interface to another data dictionary (Since R2023b)
`addPhysicalInterface`	Create named physical interface in data dictionary
`removeInterface`	Remove named interface from interface dictionary
`createInterface`	Create and set owned interface for port
`setName`	Set name for value type, function argument, interface, or element
`setInterface`	Set interface for port
`getInterface`	Get object for named interface in dictionary
`getInterfaceNames`	Get names of all interfaces in dictionary
`systemcomposer.getSelectedInterfaces`	Get selected interfaces in Interface Editor (Since R2024a)
`addAdapter`	Add adapter to architectural elements (Since R2026a)
`addInput`	Create new inputs on adapter (Since R2026a)
`getInput`	Get adapter input port by name (Since R2026a)
`connectTo`	Connect adapter to architectural elements (Since R2026a)
`updatePosition`	Update position of adapter based on destination port (Since R2026a)
`addMapping`	Add new mapping entries to adapter (Since R2026a)
`removeMapping`	Remove mapping entries for input elements in adapter (Since R2026a)

Element Management

`addElement`	Add element
`removeElement`	Remove element
`getElement`	Get object for element
`getSubElement`	Get child port element by name (Since R2026a)
`getPortElement`	Find port element by name (Since R2026a)
`setName`	Set name for value type, function argument, interface, or element
`setType`	Set shared type on data element or function argument
`createOwnedType`	Create owned value type on data element or function argument
`getSourceElement`	Gets data elements selected on source port for connection
`getDestinationElement`	Gets data elements selected on destination port for connection

Dictionary Management

`systemcomposer.createDictionary`	Create data dictionary
`systemcomposer.openDictionary`	Open data dictionary
`saveToDictionary`	Save interfaces to dictionary
`isOpen`	Determine whether dictionary is open (Since R2024a)
`getFileName`	Get absolute filename for dictionary (Since R2024a)
`linkDictionary`	Link data dictionary to architecture model
`unlinkDictionary`	Remove linked data dictionary from architecture model
`addReference`	Add reference to dictionary
`removeReference`	Remove reference to dictionary
`getReferencedDictionaries`	Get referenced dictionaries (Since R2026a)
`makeOwnedInterfaceShared`	Convert owned interface to shared interface (Since R2022a)