systemcomposer.exportModel

Export model information as MATLAB tables

Syntax

[exportedSet] = systemcomposer.exportModel(modelName)

[exportedSet,errorLog] = systemcomposer.exportModel(modelName)

Description

[exportedSet] = systemcomposer.exportModel(modelName) exports model information for components, ports, connectors, port interfaces, and requirement links, with a domain field to be imported into MATLAB^® tables. For software architectures, the programmatic interface exports function information. The exported tables have prescribed formats to specify model element relationships, stereotypes, and properties. For more information on the import structure, see the importModel function and Import and Export Architecture Models.

[exportedSet,errorLog] = systemcomposer.exportModel(modelName) exports model information to be imported into MATLAB tables with output arguments exportedSet with a structure of exported tables and errorLog to display export error information.

Examples

Export System Composer Model

To export a model, pass the model name as an argument to the exportModel function. The function returns a structure containing five tables: components, ports, connections, portInterfaces, requirementLinks, and parameters with a domain field returned as 'System' for architecture models and 'Software' for software architecture models.

exportedSet = systemcomposer.exportModel('exMobileRobot')

exportedSet = 

  struct with fields:

          components: [3×4 table]
               ports: [3×5 table]
         connections: [1×4 table]
      portInterfaces: [3×9 table]
    requirementLinks: [4×15 table]
          parameters: [6×9 table]
              domain: 'System'

Export Software Architecture Model

To export a software architecture model, pass the model name as an argument to the exportModel function. The function returns a structure containing seven tables: components, ports, connections, portInterfaces, requirementLinks, parameters, domain as 'Software', and functions.

exportedSet = systemcomposer.exportModel('mySoftwareArchitectureModel')

exportedSet = 

  struct with fields:

          components: [2×5 table]
               ports: [0×4 table]
         connections: [0×4 table]
      portInterfaces: [0×9 table]
    requirementLinks: [0×15 table]
          parameters: [0×9 table]
              domain: 'Software'
           functions: [1×4 table]

Input Arguments

modelName — Name of model

character vector | string

Name of model, specified as a character vector or string.

Example: "exMobileRobot"

Data Types: char | string

Output Arguments

exportedSet — Model tables

structure

Model tables, returned as a structure containing tables for components, ports, connections, portInterfaces, requirementLinks, and parameters, with a domain field returned as 'System' for architecture models, and 'Software' for software architecture models. For software architectures, model tables include a functions table for exported function information.

Data Types: struct

errorLog — Errors reported during export process

string array

Errors reported during export process, returned as a string array. You can obtain the error text by calling the disp method on the array of strings. For example, disp(exportLog) is used to obtain the errors reported as strings in a readable format.

Data Types: string

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
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 including extracting root-level architecture, applying profiles, linking interface data dictionaries, or generating 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 port interfaces using the Interface Editor, and parameters using the Parameter Editor.	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

Version History

Introduced in R2019a