Main Content

systemcomposer.rptgen.finder.FunctionResult class

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

Search result for functions

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 found by a systemcomposer.rptgen.finder.FunctionFinder object.

Note

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

Properties

expand all

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

Data Types: string

Name of function, returned as a string.

Data Types: string

Component where function is defined, specified as a string.

Data Types: string

Parent architecture of component where function is defined, specified as a string.

Data Types: string

Period of function, specified as a numeric value convertible to a string, or a string of valid MATLAB® variables. The Period property of aperiodic functions is editable. Editing the Period property of a periodic function will result in an error.

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

Example: [model.Architecture.Functions.ExecutionOrder]

Data Types: uint64

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

Data Types: string

Methods

expand all

Version History

Introduced in R2022b