Main Content

createInterface

Create and set owned interface for port

    Description

    example

    interface = createInterface(port,kind) creates and sets an owned interface for a port.

    Examples

    collapse all

    Create an architecture model named 'archModel'. Get the root architecture, then add a new component named 'newComponent' and a new port named 'newCompPort'. Create an owned interface for the port as a 'ValueType'.

    model = systemcomposer.createModel('archModel',true);
    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 an architecture model named 'archModel'. Get the root architecture, then add a new component named 'newComponent' and a new port named 'newCompPort'. Create an owned interface for the port as a 'DataInterface'. Remove the owned interface from the port.

    model = systemcomposer.createModel('archModel',true);
    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 an architecture model named 'archModel'. Get the root architecture, then add a new component named 'newComponent' and a new physical port named 'newCompPort'. Create an owned interface for the physical port and set the physical domain Domain property.

    model = systemcomposer.createModel('archModel',true);
    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

    collapse all

    Kind of interface, specified as a character vector or string with the options 'DataInterface', 'ValueType', or 'PhysicalDomain'.

    Output Arguments

    collapse all

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    architectureA System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. You can represent specific architectures using alternate views.

    Different types of architectures describe different aspects of systems:

    • Functional architecture describes the flow of data in a system.

    • Logical architecture describes the intended operation of a system.

    • Physical architecture describes the platform or hardware in a system.

    Compose Architecture Visually
    modelA System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.

    Perform operations on a model:

    • Extract the root-level architecture contained in the model.

    • Apply profiles.

    • Link interface data dictionaries.

    • Generate instances from model architecture.

    System Composer models are stored as SLX files.

    Create an Architecture Model with Interfaces and Requirement Links
    componentA component is a nontrivial, nearly independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architecture element, such as a function, a 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.Components
    portA 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.

    There are different types of ports:

    • Component ports are interaction points on the component to other components.

    • Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.

    Ports
    connectorConnectors 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.Connections

    TermDefinitionApplicationMore Information
    interface data dictionaryAn 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.

    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 interfaceA 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.Create an Architecture Model with Interfaces and Requirement Links
    data elementA 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:

    • Pins or wires in a connector or harness.

    • Messages transmitted across a bus.

    • Data structures shared between components.

    value typeA 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 interfaceAn owned interface is a locally defined 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
    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. Use the Adapter block to implement an adapter.

    With an adapter, you can perform 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.

    TermDefinitionApplicationMore Information
    physical subsystemA 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.Describe Component Behavior Using Simscape
    physical portA 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 a 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 Simulink.ConnectionBus object that specifies at least one Simulink.ConnectionElement object.

    Use a physical interface to bundle physical elements to describe a physical model using at least one physical domain.Specify Physical Interfaces on the Ports
    physical element

    A physical element describes the decomposition of a physical interface. A physical element is equivalent to a Simulink.ConnectionElement object.

    Define the Type of a physical element as a physical domain to enable use of that domain in a physical model.Describe Component Behavior Using Simscape

    Introduced in R2021b