systemcomposer.rptgen.finder.FunctionResult Class

Namespace: systemcomposer.rptgen.finder
Superclasses: mlreportgen.finder.Result (MATLAB Report Generator)

Search result for functions

Since R2022b

Description

Search result object for information about a function in a System Composer™ software architecture model.

The systemcomposer.rptgen.finder.FunctionResult class is a handle class.

Creation

result = FunctionResult creates a search result object for a function that you find by using a systemcomposer.rptgen.finder.FunctionFinder object.

Note

The find method of the systemcomposer.rptgen.finder.FunctionFinder class creates a search result object for each function that it finds. You do not need to create this object yourself.

Properties

Object — Universal unique identifier of result element

string

Universal unique identifier (UUID) of result element, returned as a string.

Data Types: string

Name — Name of function

string

Name of function, returned as a string.

Data Types: string

Component — Component

string

Component where you define the function, specified as a string.

Data Types: string

Parent — Parent architecture of component

string

Parent architecture of component where you define the function, specified as a string.

Data Types: string

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

Tag — Tag to associate with result

string

Tag to associate with result, specified as a string. You can use this property to attach additional information to a result. You can set this property to any value that meets your requirements.

Data Types: string

Methods

Public Methods

getReporter

Get function reporter

Examples

Generate Function Result Report

Use the FunctionFinder and FunctionResult classes to generate a report.

import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.rptgen.finder.*
import systemcomposer.rptgen.report.*

rpt = slreportgen.report.Report(output="FunctionFinderReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Software Functions"));
add(rpt,TableOfContents);

functionFinder = FunctionFinder("SoftwareModel");
functionFinder.ComponentName = "Component0";
chapter = Chapter("Title","Functions");
result = find(functionFinder);
functionsTable = Function("Source",result);

add(rpt,chapter);
append(rpt,functionsTable);
close(rpt);
rptview(rpt)

Version History

Introduced in R2022b