slreportgen.finder.DataDictionaryResult class

Package: slreportgen.finder
Superclasses: mlreportgen.finder.Result

Data dictionary search result object

Description

An object of the slreportgen.finder.DataDictionaryResult class represents a result of a search for data dictionaries. You can append a DataDictionaryResult object directly to a report. Alternatively, you can use the getReporter method to access the slreportgen.report.DataDictionary reporter for the result and then customize the reporter and append it to the report.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

You do not create an slreportgen.finder.DataDictionaryResult object explicitly. The slreportgen.finder.DataDictionaryFinder find and next methods create an slreportgen.finder.DataDictionaryResult object for each data dictionary that is found.

Properties

Object — Full path of data dictionary

string scalar

Full path of the data dictionary represented by this result, specified as a string scalar. This property is read-only.

Name — File name of data dictionary

string scalar

File name of data dictionary represented by this result, specified as a string scalar. This property is read-only.

Tag — Additional information

string | character vector | number | ...

Additional information to save with this result. You can set this property to any type of value.

Methods

Public Methods

getDefaultSummaryProperties	propList = getDefaultSummaryProperties(dictionaryResult,TypeSpecificProperties) returns the list of finder result class properties that are included by default in a summary table.
getDefaultSummaryTableTitle	tableTitle = getDefaultSummaryTableTitle(dictionaryResult,TypeSpecificTitle) returns the default title for a summary table for a finder result object of type resultObject.
getPropertyValues	propVals = getPropertyValues(dictionaryResult,propNames) returns the values of the properties specified in propNames in a cell array. Access the properties of the result object or the data dictionary represented by the finder result object by specifying the required property names in propNames.
getReporterLinkTargetID	targetID = getReporterLinkTargetID(dictionaryResult) returns the link target ID of the reporter associated with the finder result object. Use the link target ID to add a hyperlink to the reporter from any part of the report.
getReporter	reporter = getReporter(dictionaryResult) returns the slreportgen.report.DataDictionary reporter object for the specified data dictionary result. Use the reporter to customize the information reported and the formatting of the information.

Examples

Customize Reporter for Data Dictionary Result

Use the getReporter method of an slreportgen.finder.DataDictionaryResult object to access the data dictionary reporter for the result. Then, customize the reporter by setting its properties.

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

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

Create a Simulink report and add a table of contents.

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

Create a dictionary finder that searches the entire MATLAB path. Find only data dictionaries with names that begin with slrgex__fuelsys.

f = slreportgen.finder.DataDictionaryFinder();
f.Name = "slrgex_fuelsys*";

Create a chapter with a section for each data dictionary result. For each result, customize the reporter to include only the Name, Value, and Class properties in the Design Data summary table.

ch = Chapter("Data Dictionaries");
while hasNext(f)
    result = next(f);
    s = Section(result.Name);
    rptr = getReporter(result);
    rptr.SummaryProperties = ["Name" "Value" "Class"];
    append(s,rptr);
    append(ch,s);
end

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

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

The report has a section for each of the found dictionaries, slrgex_fuelsys.sldd and slrgex_fuelsys_fuel_rate_control.sldd. The summary table for each dictionary includes only the Name, Value, and Class properties.

Version History

Introduced in R2020b