systemcomposer.rptgen.finder.DictionaryResult class

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

Search result for dictionaries

Since R2022b

Description

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

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

Creation

result = DictionaryResult creates a search result object for a dictionary found by a systemcomposer.rptgen.finder.DictionaryFinder object.

Note

The find method of the systemcomposer.rptgen.finder.DictionaryFinder class creates objects of this type for each dictionary 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 dictionary

string

Name of dictionary, returned as a string.

Data Types: string

Type — Type of dictionary

"Model" | "Dictionary"

Type of dictionary, returned as "Model" for model dictionaries or "Dictionary" for reference dictionaries.

Data Types: string

Interfaces — Interfaces in dictionary

array of strings

Interfaces in dictionary, returned as an array of strings.

Data Types: string

Tag — Tag to associate with result

string

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

Version History

Introduced in R2022b