systemcomposer.exportModel
Export model information as MATLAB tables
Syntax
Description
[
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 exportedSet
] = systemcomposer.exportModel(modelName
)importModel
function and Import and Export Architecture Models.
[
exports model information to be imported into MATLAB tables with output arguments exportedSet
,errorLog
] = systemcomposer.exportModel(modelName
)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
, and
requirementLinks
, 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] domain: 'System'
Export A 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
,
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] domain: 'Software' functions: [1×4 table]
Input Arguments
modelName
— Name of model to be exported
character vector | string
Name of model to be exported, 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
, and
requirementLinks
, 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. You can represent specific architectures using alternate views. |
Different types of architectures describe different aspects of systems:
| Compose Architecture Visually |
model | A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors. |
Perform operations on a model:
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. | 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:
| 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 |
---|---|---|---|
interface data dictionary | An 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 interface | A 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. | |
data element | A 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:
| |
value type | A 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 interface | An owned interface is an 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 |
adapter | An adapter helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay or rate transition. You can also use an adapter for bus creation. Use the Adapter block to implement an adapter. |
With an adapter, you can perform functions on the Interface Adapter dialog:
|
Term | Definition | Application | More Information |
---|---|---|---|
requirements | Requirements are a collection of statements describing the desired behavior and characteristics of a system. Requirements ensure system design integrity and are achievable, verifiable, unambiguous, and consistent with each other. Each level of design should have appropriate requirements. | To enhance traceability of requirements, link system, functional, customer, performance, or design requirements to components and ports. Link requirements to each other to represent derived or allocated requirements. Manage requirements from the Requirements Manager on an architecture model or through custom views. Assign test cases to requirements using the Test Manager (Simulink Test) for verification and validation. | Link and Trace Requirements |
requirement set | A requirement set is a collection of requirements. You can structure the requirements hierarchically and link them to components or ports. | Use the Requirements
Editor (Requirements Toolbox) to edit and refine requirements in a requirement set. Requirement sets are
stored in | Manage Requirements |
requirement link | A link is an object that relates two model-based design elements. A requirement link is a link where the destination is a requirement. You can link requirements to components or ports. | View links using the Requirements Perspective in System Composer. Select a requirement in the Requirements Browser to highlight the component or the port to which the requirement is assigned. Links are stored externally as | |
test harness | A test harness is a model that isolates the component under test with inputs, outputs, and verification blocks configured for testing scenarios. You can create a test harness for a model component or for a full model. A test harness gives you a separate testing environment for a model or a model component. | Create a test harness for a System Composer component to validate simulation results and verify design. The Interface Editor is accessible in System Composer test harness models to enable behavior testing and implementation-independent interface testing. |
Term | Definition | Application | More Information |
---|---|---|---|
physical subsystem | A 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 port | A 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 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 | Use a physical interface to bundle physical elements to describe a physical model using at least one physical domain. | Specify Physical Interfaces on Ports |
physical element | A physical element describes the
decomposition of a physical interface. A physical element is equivalent to a | Define the | Describe Component Behavior Using Simscape |
Version History
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)