createInterface
Description
Examples
Create Owned Interface as Value Type
Create an architecture model archModel
. Get the
root architecture, then add a new component newComponent
and a new port
newCompPort
. Create an owned interface for the port as a
ValueType
.
model = systemcomposer.createModel("archModel"); systemcomposer.openModel("archModel"); rootArch = get(model,"Architecture"); newComponent = addComponent(rootArch,"newComponent"); newPort = addPort(newComponent.Architecture,"newCompPort","in"); interface = newPort.createInterface("ValueType")
interface = ValueType with properties: Name: '' DataType: 'double' Dimensions: '1' Units: '' Complexity: 'real' Minimum: '[]' Maximum: '[]' Description: '' Owner: [1×1 systemcomposer.arch.ArchitecturePort] Model: [1×1 systemcomposer.arch.Model] UUID: 'd23669e1-f26c-4c64-a482-a27a33ac6541' ExternalUID: ''
Create Owned Interface as Data Interface and Remove Owned Interface
Create an architecture model archModel
. Get the root
architecture, then add a new component newComponent
and a new port
newCompPort
. Create an owned interface for the port as a
DataInterface
.
model = systemcomposer.createModel("archModel"); rootArch = get(model,"Architecture"); newComponent = addComponent(rootArch,"newComponent"); newPort = addPort(newComponent.Architecture,"newCompPort","in"); interface = newPort.createInterface("DataInterface");
Remove the owned interface from the port.
newPort.setInterface("");
Create Owned Interface for Physical Port as Physical Domain
Create an architecture model archModel
. Get the
root architecture, then add a new component newComponent
and a new
physical port newCompPort
. Create an owned interface for the physical
port and set the physical domain Domain
property.
model = systemcomposer.createModel("archModel"); rootArch = get(model,"Architecture"); newComponent = addComponent(rootArch,"newComponent"); newPort = addPort(newComponent.Architecture,"newCompPort","physical"); port = newComponent.getPort("newCompPort"); interface = port.createInterface("PhysicalDomain"); interface.Domain = "rotational.rotational"
interface = PhysicalDomain with properties: Domain: 'foundation.mechanical.rotational.rotational' Owner: [1×1 systemcomposer.arch.ArchitecturePort] Model: [1×1 systemcomposer.arch.Model] UUID: '65f143cb-ed3a-49e1-bbc9-de89e84aa8e6' ExternalUID: ''
Input Arguments
port
— Port
port object
Port, specified as a systemcomposer.arch.ArchitecturePort
or systemcomposer.arch.ComponentPort
object.
kind
— Kind of interface
"DataInterface"
| "ValueType"
| "PhysicalDomain"
Kind of interface, specified as one of these options:
"DataInterface"
"ValueType"
"PhysicalDomain"
Data Types: char
| string
Output Arguments
interface
— Interface
data interface object | value type object | physical domain object
Interface, returned as a systemcomposer.interface.DataInterface
, systemcomposer.ValueType
, or systemcomposer.interface.PhysicalDomain
object.
More About
Definitions
Term | Definition | Application | More Information |
---|---|---|---|
architecture | A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. |
Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor. | |
root | A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest. | The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary. | |
model | A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors. |
Perform operations on a model:
A System Composer model is stored as an SLX file. | Create Architecture Model with Interfaces and Requirement Links |
component | A component is a replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, another system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction. | Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with:
| |
port | A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems. |
| |
connector | Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures. | A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact. |
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. | |
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 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:
|
Term | Definition | Application | More Information |
---|---|---|---|
physical subsystem | A physical subsystem is a Simulink® subsystem with Simscape™ connections. | A physical subsystem with Simscape connections uses a physical network approach suited for simulating systems with real physical components and represents a mathematical model. | Implement Component Behavior Using Simscape |
physical port | A physical port represents a Simscape physical modeling connector port called a Connection Port (Simscape). | Use physical ports to connect components in an architecture model or to enable physical systems in a Simulink subsystem. | Define Physical Ports on Component |
physical connector | A physical connector can represent a nondirectional conserving connection of a specific physical domain. Connectors can also represent physical signals. | Use physical connectors to connect physical components that represent features of a system to simulate mathematically. | Architecture Model with Simscape Behavior for a DC Motor |
physical interface | A physical interface defines the kind of
information that flows through a physical port. The same interface can be assigned to multiple
ports. A physical interface is a composite interface equivalent to a | Use a physical interface to bundle physical elements to describe a physical model using at least one physical domain. | Specify Physical Interfaces on Ports |
physical element | A physical element describes the
decomposition of a physical interface. A physical element is equivalent to a | Define the | Describe Component Behavior Using Simscape |
Version History
Introduced in R2021b
See Also
Functions
addInterface
|moveInterface
|addPhysicalInterface
|removeInterface
|setName
|setInterface
|getInterface
|getInterfaceNames
|addElement
|removeElement
|getElement
|setName
|setType
|createOwnedType
|getSourceElement
|getDestinationElement
|systemcomposer.createDictionary
|systemcomposer.openDictionary
|saveToDictionary
|isOpen
|getFileName
|linkDictionary
|unlinkDictionary
|addReference
|removeReference
|makeOwnedInterfaceShared
|addValueType
|setName
|setDataType
|setDimensions
|setUnits
|setComplexity
|setMinimum
|setMaximum
|setDescription
|addServiceInterface
|setFunctionPrototype
|getFunctionArgument
|setAsynchronous
|systemcomposer.getSelectedInterfaces
Objects
systemcomposer.ValueType
|systemcomposer.interface.DataInterface
|systemcomposer.interface.DataElement
|systemcomposer.interface.PhysicalDomain
|systemcomposer.interface.PhysicalInterface
|systemcomposer.interface.PhysicalElement
|systemcomposer.interface.Dictionary
|systemcomposer.interface.ServiceInterface
|systemcomposer.interface.FunctionArgument
|systemcomposer.interface.FunctionElement
|addServiceInterface
|setFunctionPrototype
|getFunctionArgument
|setAsynchronous
Blocks
Tools
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)