Main Content

systemcomposer.createModel

Create System Composer model

collapse all in page

    Syntax

    model = systemcomposer.createModel(modelName,FileType=fileType)
    model = systemcomposer.createModel(modelName,modelType,FileType=fileType)

    Description

    model = systemcomposer.createModel(modelName,FileType=fileType) creates a System Composer™ model or subsystem with name modelName and returns the systemcomposer.arch.Model object.

    example

    model = systemcomposer.createModel(modelName,modelType,FileType=fileType) creates a System Composer model or subsystem with name modelName and type modelType and returns the systemcomposer.arch.Model object.

    Examples

    collapse all

    Create a model and display its properties.

    model = systemcomposer.createModel("model_name")
    model = 

  model with properties:

                   Name: 'model_name'
           Architecture: [1×1 systemcomposer.arch.Architecture]
         SimulinkHandle: 2.0005
                  Views: [0×0 systemcomposer.view.ViewArchitecture]
               Profiles: [0×0 systemcomposer.profile.Profile]
    InterfaceDictionary: [1×1 systemcomposer.interface.Dictionary]

    Input Arguments

    collapse all

    Name of new model or subsystem, specified as a character vector or string. This name must be a valid MATLAB® identifier.

    Example: "model_name"

    Data Types: char | string

    Type of model or subsystem to create, specified as "Architecture" for an architecture, "SoftwareArchitecture" for a software architecture, or "AutosarArchitecture" for an AUTOSAR architecture.

    Data Types: char | string

    Type of file to create, specified as "Model" for an architecture model or "Subsystem" for an architecture subsystem.

    Data Types: char | string

    Output Arguments

    collapse all

    Architecture model, returned as a systemcomposer.arch.Model object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore 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.

    Compose Architectures Visually

    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:

    • Extract root-level architecture.

    • Apply profiles.

    • Link interface data dictionaries.

    • Generate instances from model architecture.

    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:

    Compose Architectures Visually

    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.

    • 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. The root architecture has a boundary defined by its ports.

    Compose Architectures Visually

    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.

    Compose Architectures Visually

    TermDefinitionApplicationMore Information
    software architecture

    A software architecture is a specialization of an architecture for software-based systems, including the description of software compositions, component functions, and their scheduling.

    Use software architectures in System Composer to author software architecture models composed of software components, ports, and interfaces. Design your software architecture model, define the execution order of your component functions, simulate your design in the architecture level, and generate code.
    software component

    A software component is a specialization of a component for software entities, including its interfaces.

    Implement a Simulink® export-function, rate-based, or JMAAB model as a software component, simulate the software architecture model, and generate code.
    software composition

    A software composition is a diagram of software components and connectors that represents a composite software entity, such as a module or application.

    Encapsulate functionality by aggregating or nesting multiple software components or compositions.

    		Model Software Architecture of Throttle Position Control System
    function

    A function is an entry point where a transfer of program control occurs and can be defined in a software component.

    You can apply stereotypes to functions in software architectures, edit sample times, and specify the function period using the Functions Editor.

    		Author and Extend Functions for Software Architectures
    function element

    A function element describes the attributes of a function in a client-server interface.

    Edit the function prototype on a function element to change the number and names of inputs and outputs of the function. Edit function element properties as you would edit other interface element properties. Function argument types can include built-in types as well as bus objects. You can specify function elements to support:

    • Synchronous execution — When the client calls the server, the function runs immediately and returns the output arguments to the client.

    • Asynchronous execution — When the client makes a request to call the server, the function is executed asynchronously based on the priority order defined in the Functions Editor and Schedule Editor and returns the output arguments to the client.

    		systemcomposer.interface.FunctionElement
    function argument

    A function argument describes the attributes of an input or output argument in a function element.

    You can set the properties of a function argument in the Interface Editor just as you would other value types: Type, Dimensions, Units, Complexity, Minimum, Maximum, and Description.

    		systemcomposer.interface.FunctionArgument
    service interface

    A service interface defines the functional interface between client and server components. Each service interface consists of one or more function elements.

    Once you have defined a service interface in the Interface Editor, you can assign it to client and server ports using the Property Inspector. You can also use the Property Inspector to assign stereotypes to service interfaces.
    server

    A server is a component that defines and provides a function.

    A server component is where the function is defined. You can implement function behavior in a Simulink export-function model.

    		Service Interfaces Overview
    client

    A client is a component that sends a request to the server.

    A client component is where the function is called. The implementation of function call behavior is dependent on the synchronicity of the function execution.

    		Service Interfaces Overview
    class diagram

    A class diagram is a graphical representation of a static structural model that displays unique architecture types of the software components optionally with software methods and properties.

    Class diagrams capture one instance of each referenced model and show relationships between them. A component diagram view can be optionally represented as a class diagram for a software architecture model.

    		Class Diagram View of Software Architectures

    Version History

    Introduced in R2019a

    expand all

    See Also

    Functions

    Objects

    Blocks

    Topics