systemcomposer.arch.Function

Software architecture function

Since R2021b

Description

A Function object represents a function in a software architecture model.

Use the Functions Editor from the toolstrip on a software architecture model, to edit the simulation execution order and sample time of functions with inherited sample time (-1) in your software architecture.

Creation

Get functions in a software architecture model with the Functions property on the systemcomposer.arch.Architecture object.

model = systemcomposer.openModel('ThrottleControlComposition');
sim('ThrottleControlComposition');
functions = model.Architecture.Functions

Properties

expand all

`Model` — Architecture model
model object

Architecture model where element belongs, specified as a systemcomposer.arch.Model object.

`Name` — Name of function
character vector

Name of function, specified as a character vector.

Data Types: char

`Component` — Component where function is defined
component object

Component where function is defined, specified as a systemcomposer.arch.Component object.

`Parent` — Parent architecture of element
architecture object

Parent architecture of element where function is defined, specified as a systemcomposer.arch.Architecture object.

`Period` — Period of function
numeric | string

Period of function, specified as a numeric value convertible to a string, or a string of valid MATLAB^® variables. You can edit the Period property of aperiodic functions. If you edit the Period property of a periodic function, you see an error.

`ExecutionOrder` — Execution order of functions
row vector of numeric values

Execution order of functions, specified as a row vector of numeric values.

Example: [model.Architecture.Functions.ExecutionOrder]

Data Types: uint64

`ExternalUID` — Unique external identifier
character vector

Unique external identifier, specified as a character vector. The external ID is preserved over the lifespan of the element and through all operations that preserve the UUID.

Data Types: char

`UUID` — Universal unique identifier
character vector

Universal unique identifier, specified as a character vector.

Example: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

Data Types: char

Object Functions

`increaseExecutionOrder`	Change function execution order to later
`decreaseExecutionOrder`	Change function execution order to earlier
`applyStereotype`	Apply stereotype to architecture model element
`getStereotypes`	Get stereotypes applied on element of architecture model
`removeStereotype`	Remove stereotype from model element
`setProperty`	Set property value corresponding to stereotype applied to element
`getProperty`	Get property value corresponding to stereotype applied to element
`getPropertyValue`	Get value of architecture property
`getEvaluatedPropertyValue`	Get evaluated value of property from element
`getStereotypeProperties`	Get stereotype property names on element
`hasStereotype`	Find if element has stereotype applied
`hasProperty`	Find if element has property
`destroy`	Remove model element

Examples

collapse all

Change Execution Order of Software Functions

This example uses:

Open Live Script

This example shows the software architecture of a throttle position control system and how to schedule the execution order of the root level functions.

model = systemcomposer.openModel("ThrottleControlComposition");

Simulate the model to populate it with functions.

sim("ThrottleControlComposition");

View the function names ordered by execution order.

functions = {model.Architecture.Functions.Name}'

functions = 6x1 cell
    {'Actuator_output_5ms'   }
    {'Controller_run_5ms'    }
    {'TPS_Primary_read_5ms'  }
    {'TPS_Secondary_read_5ms'}
    {'TP_Monitor_D1'         }
    {'APP_Sensor_read_10ms'  }

Decrease the execution order of the third function.

decreaseExecutionOrder(model.Architecture.Functions(3))

View the function names ordered by execution order.

functions = {model.Architecture.Functions.Name}'

functions = 6x1 cell
    {'Actuator_output_5ms'   }
    {'TPS_Primary_read_5ms'  }
    {'Controller_run_5ms'    }
    {'TPS_Secondary_read_5ms'}
    {'TP_Monitor_D1'         }
    {'APP_Sensor_read_10ms'  }

The third function is now moved up in execution order, executing earlier.

Increase the execution order of the second function.

increaseExecutionOrder(model.Architecture.Functions(2))

View the function names ordered by execution order.

functions = {model.Architecture.Functions.Name}'

functions = 6x1 cell
    {'Actuator_output_5ms'   }
    {'Controller_run_5ms'    }
    {'TPS_Primary_read_5ms'  }
    {'TPS_Secondary_read_5ms'}
    {'TP_Monitor_D1'         }
    {'APP_Sensor_read_10ms'  }

The second function is now moved down in execution order, executing later.

More About

expand 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 R2021b

systemcomposer.arch.Function

Description

Creation

Properties

`Model` — Architecture model
model object

`Name` — Name of function
character vector

`Component` — Component where function is defined
component object

`Parent` — Parent architecture of element
architecture object

`Period` — Period of function
numeric | string

`ExecutionOrder` — Execution order of functions
row vector of numeric values

`ExternalUID` — Unique external identifier
character vector

`UUID` — Universal unique identifier
character vector

Object Functions

Examples

Change Execution Order of Software Functions

More About

Definitions

Version History

See Also

Topics

systemcomposer.arch.Function

Description

Creation

Properties

Model — Architecture model model object

Name — Name of function character vector

Component — Component where function is defined component object

Parent — Parent architecture of element architecture object

Period — Period of function numeric | string

ExecutionOrder — Execution order of functions row vector of numeric values

ExternalUID — Unique external identifier character vector

UUID — Universal unique identifier character vector

Object Functions

Examples

Change Execution Order of Software Functions

More About

Definitions

Version History

See Also

Topics

`Model` — Architecture model
model object

`Name` — Name of function
character vector

`Component` — Component where function is defined
component object

`Parent` — Parent architecture of element
architecture object

`Period` — Period of function
numeric | string

`ExecutionOrder` — Execution order of functions
row vector of numeric values

`ExternalUID` — Unique external identifier
character vector

`UUID` — Universal unique identifier
character vector