Main Content

systemcomposer.exportModel

Export model information as MATLAB tables

    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.

    example

    [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

    collapse all

    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'

    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

    collapse all

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

    Example: "exMobileRobot"

    Data Types: char | string

    Output Arguments

    collapse all

    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

    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

    collapse all

    Version History

    Introduced in R2019a