systemcomposer.createModel

Create System Composer model

Since R2019a

Syntax

model = systemcomposer.createModel(modelName)

model = systemcomposer.createModel(modelName,openFlag)

model = systemcomposer.createModel(modelName,modelType,openFlag)

Description

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

model = systemcomposer.createModel(modelName,openFlag) creates a System Composer model with name modelName and returns the systemcomposer.arch.Model object. This function opens the model according to the value of the optional argument openFlag.

model = systemcomposer.createModel(modelName,modelType,openFlag) creates a System Composer model with name modelName and type modelType and returns the systemcomposer.arch.Model object. This function opens the model according to the value of optional argument openFlag.

Examples

Create Model

Create a model, open it, and display its properties.

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

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

modelName — Name of new model

character vector | string

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

Example: "model_name"

Data Types: char | string

openFlag — Whether to open model

false or 0 (default) | true or 1

Whether to open model upon creation, specified as a logical.

Data Types: logical

modelType — Type of model

"Architecture" (default) | "SoftwareArchitecture"

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

Data Types: char | string

Output Arguments

model — Architecture model

model object

Architecture model, returned as a systemcomposer.arch.Model 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.	Compose Architectures Visually Author Parameters in System Composer Using Parameter Editor
model	A 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. A System Composer model is stored as an SLX file.	Create Architecture Model with Interfaces and Requirement Links
component	A 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 architectural 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. Transfer information between components with: Port interfaces using the Interface Editor Parameters using the Parameter Editor	Components
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.	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
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.	Connections

Term	Definition	Application	More 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.	Author Software Architectures Simulate and Deploy Software Architectures
software component	A software component is a specialization of a component for software entities, including its functions (entry points) and interfaces.	Implement a Simulink® export-function, rate-based, or JMAAB model as a software component, simulate the software architecture model, and generate code.	Implement Behaviors for Architecture Model Simulation Create Software Architecture from Component
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.	Modeling Software Architecture of Throttle Position Control System
function	A function is an entry point that 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
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.	Author Service Interfaces for Client-Server Communication systemcomposer.interface.ServiceInterface
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 any value type: Type, Dimensions, Units, Complexity, Minimum, Maximum, and Description.	systemcomposer.interface.FunctionArgument
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. Any 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