addFunction

Add functions to architecture of software component

Since R2022a

Syntax

functions = addFunction(arch,functionNames)

Description

functions = addFunction(arch,functionNames) adds a set of functions with the names specified, functionNames to the software architecture component architecture. The addfunction function adds functions to the software architecture of a component. Use <component>.Architecture to access the architecture of a component.

To remove a function, use the destroy function.

example

Examples

collapse all

Add Functions to Software Architecture Component

Create a model named mySoftwareArchitecture and get the root architecture.

model = systemcomposer.createModel("mySoftwareArchitecture","SoftwareArchitecture");
rootArch = model.Architecture

Architecture with properties:
 
                   Name: 'mySoftwareArchitecture'
             Definition: Composition
                 ...
            ExternalUID: ''
              Functions: []

Create a software component and two functions.

newComp = rootArch.addComponent("C1");
newFuncs = newComp.Architecture.addFunction({'f1','f2'});
rootArch

rootArch =
 
  Architecture with properties:
 
                   Name: 'mySoftwareArchitecture'
             Definition: Composition
                ...
            ExternalUID: ''
              Functions: [1x2 systemcomposer.arch.Function]

Input Arguments

collapse all

`arch` — Architecture
architecture object

Architecture, specified as a systemcomposer.arch.Architecture object.

`functionNames` — Names of functions
cell array of character vectors | array of strings

Names of functions, specified as a cell array of character vectors or an array of strings.

Data Types: char | string

Output Arguments

collapse all

`functions` — Handles to created functions
array of function objects

Created functions, returned as an array of systemcomposer.arch.Function objects.

More About

collapse all

Definitions

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 R2022a

addFunction

Syntax

Description

Examples

Add Functions to Software Architecture Component

Input Arguments

`arch` — Architecture
architecture object

`functionNames` — Names of functions
cell array of character vectors | array of strings

Output Arguments

`functions` — Handles to created functions
array of function objects

More About

Definitions

Version History

See Also

Topics

addFunction

Syntax

Description

Examples

Add Functions to Software Architecture Component

Input Arguments

arch — Architecture architecture object

functionNames — Names of functions cell array of character vectors | array of strings

Output Arguments

functions — Handles to created functions array of function objects

More About

Definitions

Version History

See Also

Topics

`arch` — Architecture
architecture object

`functionNames` — Names of functions
cell array of character vectors | array of strings

`functions` — Handles to created functions
array of function objects