slreportgen.finder.DataDictionaryFinder class

Package: slreportgen.finder
Superclasses: mlreportgen.finder.Finder

Find data dictionaries

Since R2020b

Description

Use an object of the slreportgen.finder.DataDictionaryFinder class to find Simulink^® data dictionaries.

The slreportgen.finder.DataDictionaryFinder class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

finder = slreportgen.finder.DataDictionaryFinder() creates a data dictionary finder and sets the Container property to 'MATLABPath'.

You can constrain the search by setting the properties of the finder. Use the methods of the finder to perform the search.

Note

This finder provides two ways to get search results:

• To return the search results as an array, use the find method. Add the results directly to a report or process the results in a for loop.

• To iterate through the results one at a time, use the hasNext and next methods in a while loop.

Neither option has a performance advantage.

finder = slreportgen.finder.DataDictionaryFinder(searchFolder) creates a data dictionary finder and sets the Container property to the folder or folders specified by searchFolder.

finder = slreportgen.finder.DataDictionaryFinder(Name=Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order.

Properties

Container — Folders to search for data dictionaries

string array | character vector | cell array of character vectors

Folders to search for data dictionaries, specified as a string array, character vector, or cell array of character vectors. Strings and character vectors can include the * and the ** wildcards. Characters next to the ** wildcard must be file separators. For example, to find all data dictionaries in the exampleFolder folder and its subfolders, set Container to "exampleFolder\**". If Container is set to 'MATLABPath', the finder searches for data dictionaries in the current folder and all folders on the MATLAB^® path.

Name — Data dictionary to find

string scalar | character vector

Data dictionary to find, specified as a string scalar or character vector. The Name property value can include the * wildcard. For example, to find all data dictionaries that begin with sldemo_fuelsys_dd, set the Name property to "sldemo_fuelsys_dd*". The name or expression specified in this property must have no file name extension or the extension .sldd.

Properties — Properties of data dictionaries to find

{} (default) | cell array

Properties of the data dictionaries to find, specified as a cell array of name-value pairs. Use the Properties property to filter the finder results by the data dictionary properties. The finder searches the folders specified by the Container property for data dictionaries with names that match the Name property and that have the specified properties values. For data dictionary properties, see Simulink.data.Dictionary. For example, to return only the data dictionaries that have access to the base workspace, set Properties to {'HasAccessToBaseWorkspace',true}.

Methods

Public Methods

find	results = find(finder) finds data dictionaries in a model or subsystem according to the constraints specified by the finder. The variables are returned as an array of slreportgen.finder.DataDictionaryResult objects. Append all of the results directly to a report or process the results in a for loop. In the loop, you can customize the content and formatting for a data dictionary by setting the properties of the reporter for the data dictionary. Get the reporter by using the getReporter method of the slreportgen.finder.DataDictionaryResult object that contains the data dictionary.
hasNext	tf = hasNext(finder) returns true if a data dictionary returned by the finder is available for the next method to retrieve. If the finder does not return any data dictionaries, or if all dictionaries have been retrieved, hasNext returns false. Use hasNext and next to iterate through the data dictionaries in a while loop. In the loop, you can customize the content and formatting for a data dictionary by setting properties of the reporter for the data dictionary. Get the reporter by using the getReporter method of the slreportgen.finder.DataDictionaryResult object.
next	result = next(finder) returns the next data dictionary as an slreportgen.finder.DataDictionaryResult object. Use hasNext and next to iterate through found data dictionaries in a while loop. In the loop, you can customize the content and formatting for a data dictionary by setting the properties of the reporter for the data dictionary. Get the reporter by using the getReporter method of the slreportgen.finder.DataDictionaryResult object.

Examples

Find and Report on Data Dictionary

To report on data dictionaries, create an slreportgen.DataDictionaryFinder object. Use the object properties to constrain the search and the methods to get the results.

Import the MATLAB Report and Simulink Report API packages so that you do not have to use long, fully qualified class names.

import mlreportgen.report.*
import slreportgen.finder.*
import slreportgen.report.*

Create a Simulink report and append a table of contents to the report.

rpt = slreportgen.report.Report("MyReport","html-file");
append(rpt,TableOfContents);

Create a Simulink data dictionary finder to search the entire MATLAB path.

f = DataDictionaryFinder();

Constrain the finder to find only data dictionaries that have names that begin with slrgex_fuelsys.

f.Name = "slrgex_fuelsys*";

Create a chapter for the data dictionaries.

ch = Chapter("Data Dictionaries");

For each found dictionary, create a section and append it to the chapter.

while hasNext(f)
    result = next(f);
    s = Section(result.Name);
    append(s,result);
    append(ch,s);
end

Append the chapter to the report. Close and view the report.

append(rpt,ch);
close(rpt);
rptview(rpt);

Version History

Introduced in R2020b