createSimulinkBehavior

Create Simulink behavior and link to component

Syntax

createSimulinkBehavior(component,modelName)

createSimulinkBehavior(component,modelName,"Type",type)

createSimulinkBehavior(component,"Type",type)

createSimulinkBehavior(component,modelName,"BehaviorType",behavior)

Description

createSimulinkBehavior(component,modelName) creates a new Simulink^® model, modelName, with the same interfaces as the component component and links the component to the new model. The component must have no children.

Note

Components with physical ports cannot be saved as architecture models, model references, software architectures, or Stateflow^® chart behaviors. Components with physical ports can only be saved as subsystem references or as subsystem component behaviors.

If no functions are present in software architectures, this syntax creates a rate-based behavior. If functions are present, the syntax creates an export-function behavior.

createSimulinkBehavior(component,modelName,"Type",type) creates a new Simulink model or subsystem behavior, modelName, with the same interfaces as the component component and links the component to the new model. For more information, see Create Referenced Simulink Behavior Model.

Use this syntax to convert a subsystem component to a subsystem reference.

createSimulinkBehavior(component,"Type",type) creates a subsystem component behavior that is part of the parent model. The connections, interfaces, requirement links, and stereotypes of the component are preserved. The component must have no subcomponents and must not already be linked to a model. For more information, see Create Simulink Behavior Using Subsystem Component.

createSimulinkBehavior(component,modelName,"BehaviorType",behavior) creates a new Simulink rate-based or export-function behavior, modelName, and links the software component to the new model. You can create rate-based or export-function behaviors for software architectures.

Examples

Create Simulink Model and Link to Component

Create a Simulink model behavior for the component robotComp in Robot.slx and link the model file to the component.

Create a model archModel.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");

Add two components to the model electricComp and robotComp. Rearrange the model.

names = ["electricComp","robotComp"];
comp = addComponent(arch,names);
Simulink.BlockDiagram.arrangeSystem("archModel")

Create a Simulink behavior model for the robotComp component so the component references the Simulink model Robot.slx.

createSimulinkBehavior(comp(2),"Robot")

Create Subsystem Reference Component

Create a Simulink subsystem behavior for the component robotComp in Robot.slx and link the subsystem file to the component.

Create a model archModel.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");

Add two components to the model electricComp and robotComp. Rearrange the model.

names = ["electricComp","robotComp"];
comp = addComponent(arch,names);
Simulink.BlockDiagram.arrangeSystem("archModel")

Create a Simulink subsystem reference behavior for the robotComp component so the component references the Simulink subsystem Robot.slx.

createSimulinkBehavior(comp(2),"Robot",Type="SubsystemReference")

Create Subsystem Component Behavior and Convert to Subsystem Reference

Create a Simulink subsystem behavior for the component robotComp in Robot.slx and link the subsystem file to the component.

Create a model archModel.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");

Add two components to the model electricComp and robotComp. Rearrange the model.

names = ["electricComp","robotComp"];
comp = addComponent(arch,names);
Simulink.BlockDiagram.arrangeSystem("archModel")

Create a Simulink subsystem component behavior for the robotComp component that is part of the parent model.

createSimulinkBehavior(comp(2),Type="Subsystem")

Convert the subsystem component to a subsystem reference component behavior so the component references the Simulink subsystem Robot.slx.

createSimulinkBehavior(comp(2),"Robot",Type="SubsystemReference")

Create Simulink Model with Export-Function Behavior and Link to Software Component

Create a Simulink model with export-function behavior myBehaviorModel.slx for the software component named C1 and link the model to the component.

Create a software architecture model named mySoftwareModel.

model=systemcomposer.createModel("mySoftwareModel","SoftwareArchitecture");
systemcomposer.openModel("mySoftwareModel");
arch = get(model,"Architecture");

Add a component C1 to the model.

comp = addComponent(arch,"C1");

Create a Simulink model with an export-function behavior named myBehaviorModel.slx that is referenced by the component C1.

createSimulinkBehavior(comp,"myBehaviorModel",BehaviorType="ExportFunction")

Input Arguments

component — System or software architecture component

component object

System or software architecture component with no children, specified as a systemcomposer.arch.Component object. This component can also be specified as a subsystem component to be converted to a subsystem reference.

modelName — Name of model

character vector | string

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

Example: "exMobileRobot"

Data Types: char | string

behavior — Component behavior

"RateBased" | "ExportFunction"

Component behavior, specified as one of these values:

• "RateBased" to create a rate-based component behavior

• "ExportFunction" to create an export-function component behavior

Data Types: char | string

type — Component behavior

"ModelReference" | "SubsystemReference" | "Subsystem"

Component behavior, specified as one of these values:

• "ModelReference" to create a Simulink model reference component behavior

• "SubsystemReference" to create a Simulink subsystem reference component behavior

• "Subsystem" to create a Simulink subsystem component behavior

Data Types: char | 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: 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: Port interfaces using the Interface Editor 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

Term	Definition	Application	More Information
reference component	A reference component is a component whose definition is a separate architecture model, Simulink behavior model, or Simulink subsystem behavior. A reference component represents a logical hierarchy of other compositions.	You can synchronize and reuse reference components as Reference Component blocks. There are three types of reference components: Model references are Simulink models. Subsystem references are Simulink subsystems. Architecture references are System Composer architecture models or subsystems.	Implement Component Behavior Using Simulink Create Architecture Reference Reference Component
parameter	A parameter is an instance-specific value of a value type.	Parameters are available for inlined architectures and components. Parameters are also available for components linked to model, subsystem, or architecture references that specify model arguments. You can specify independent values for a parameter on each component.	Author Parameters in System Composer Using Parameter Editor Access Model Arguments as Parameters on Reference Components Use Parameters to Store Instance Values with Components
subsystem component	A subsystem component is a Simulink subsystem that is part of the parent System Composer architecture model.	Add Simulink subsystem behavior to a component to author a subsystem component in System Composer. You cannot synchronize and reuse subsystem components as Reference Component blocks because the component is part of the parent model.	Create Simulink Behavior Using Subsystem Component Create Simulink Subsystem Component
state chart	A state chart diagram demonstrates the state-dependent behavior of a component throughout its state lifecycle and the events that can trigger a transition between states.	Add Stateflow chart behavior to describe a component using state machines. You cannot synchronize and reuse Stateflow chart behaviors as Reference Component blocks because the component is part of the parent model.	Implement Behaviors for Architecture Model Simulation Implement Component Behavior Using Stateflow Charts

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 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.	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.	Service Interfaces Overview systemcomposer.interface.ServiceInterface
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