slreportgen.report.BusObject Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

Simulink bus object reporter

Description

Creates a reporter that generates information about a Simulink.Bus object in a report.

Note

To use a bus object reporter in a report, you must create the report using the slreportgen.report.Report class or subclass.

The slreportgen.report.BusObject class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = slreportgen.report.BusObject creates an empty slreportgen.report.BusObject reporter object. Customize the content and formatting of the information reported for a bus object by using the reporter object properties. Before you add the reporter to a report, you must set the Object property of the reporter to an slreportgen.report.ModelVariableResult or Simulink.VariableUsage object that specifies a Simulink.Bus object. Adding an empty reporter to a report produces an error.

reporter = slreportgen.report.BusObject(object) creates a reporter for the Simulink.Bus object specified by an slreportgen.report.ModelVariableResult or Simulink.VariableUsage object. See the Object property.

reporter = slreportgen.report.BusObject(PropertyName=Value) sets the reporter properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

Object — Object that specifies a Simulink.Bus object

slreportgen.finder.ModelVariableResult object | Simulink.VariableUsage object

Object that specifies the Simulink.Bus object to report, specified as an slreportgen.finder.ModelVariableResult object or a Simulink.VariableUsage object.

Attributes:

GetAccess	public
SetAccess	public

Name — Name of bus object

string scalar

Name of bus object to report, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

ReportedBusProperties — Bus object properties to report

[] (default) | string array | cell array of character vectors

Bus object properties to report, specified as a string array or a cell array of character vectors. The properties specified by the ReportedBusProperties property are further filtered by the PropertyFilterFcn property. If the ReportedBusProperties property is empty, the reporter includes all properties in the report, except the properties filtered by the PropertyFilterFcn property. The reporter excludes any bus object property that is not valid for the bus object.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string | cell

ReportedElementProperties — Bus element properties to report

[] (default) | string array | cell array of character vectors

Bus element properties to report, specified as a string array or a cell array of character vectors. The properties specified by the ReportedElementProperties property are further filtered by the function or code specified in the PropertyFilterFcn property. If the ReportedElementProperties property is empty, the reporter includes all properties in the report, except the properties filtered by the PropertyFilterFcn property. The reporter excludes any bus element property that is not valid for the bus element.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string | cell

ShowName — Whether to show name of bus

0 (false) (default) | 1 (true)

Whether to show the name of the bus object in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show the name of the bus object in the report.

• 0 (false) — Omit the name of the bus object in the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowHierarchy — Whether to show hierarchy of the bus object

1 (true) (default) | 0 (false)

Whether to show a nested list that represents the bus hierarchy in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show a nested list that represents the bus hierarchy in the report.

• 0 (false) — Omit the bus hierarchy in the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowProperties — Whether to show bus object properties

1 (true) (default) | 0 (false)

Whether to show the bus object properties table in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show the bus object properties table in the report.

• 0 (false) — Omit the bus object properties table in the report.

Data Types: logical

ShowElements — Whether to show bus object elements properties

1 (true) (default) | 0 (false)

Whether to show the bus object element properties table in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show the bus object element properties table in the report.

• 0 (false) — Omit the bus object element properties table in the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowUsedBy — Whether to show blocks that use bus object

1 (true) (default) | 0 (false)

Whether to show a list of the blocks that use the bus object, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The reporter includes a list of the blocks that use the bus object in the report. If the ShowUsedBySnapshot property is also set to true, the reporter includes a diagram snapshot for each parent subsystem that uses the bus object. Blocks that use the bus object are highlighted in the snapshot.

• 0 (false) — Omit a list of the blocks that use the bus object.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowUsedBySnapshot — Whether to show diagram snapshots highlighting blocks that use bus object

1 (true) (default) | 0 (false)

Whether to show diagram snapshots of parent subsystems and highlight the blocks that use the bus object, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The report includes a snapshot for each parent subsystem that uses the bus object. Blocks that use the bus object are highlighted in the snapshot. If a parent subsystem has more than one block that uses the bus object, the reporter shows only one diagram snapshot that highlights the blocks that use the bus object.

• 0 (false) — Omit diagram snapshots of parent subsystems.

Attributes:

GetAccess	public
SetAccess	public

CreateSections — Whether to create sections

1 (true) (default) | 0 (false)

Whether to create a separate section for each type of information about the bus object in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The reporter creates an mlreportgen.report.Section with a title for each of these types of information:

  • hierarchy

  • properties

  • elements

  • blocks that use the bus object

• 0 (false) — The reporter generates labels for tables and lists. For a table, the reporter generates a table title. For a list, the reporter generates text that precedes the list.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

HierarchyListFormatter — List formatter for hierarchy

mlreportgen.dom.UnorderedList | mlreportgen.dom.OrderedList

List formatter that formats the generated bus hierarchy, specified as an mlreportgen.dom.UnorderedList object or an mlreportgen.dom.OrderedList object. The default value of this property is an object of mlreportgen.dom.UnorderedList. To customize the list formatting, modify the list object properties or replace the list object with a customized list object that does not contain list items.

Attributes:

GetAccess	public
SetAccess	public

UsedByListFormatter — List formatter for blocks that use the bus object

mlreportgen.dom.UnorderedList | mlreportgen.dom.OrderedList

List formatter that formats the generated list of blocks that use the bus object, specified as an mlreportgen.dom.UnorderedList object or an mlreportgen.dom.OrderedList object. The default value of this property is an object of mlreportgen.dom.UnorderedList. To customize the list formatting, modify the list object properties or replace the list object with a customized list object that does not contain list items.

Attributes:

GetAccess	public
SetAccess	public

PropertiesTableReporter — Table reporter for bus object properties

mlreportgen.report.BaseTable

Table reporter used to format the table of bus object properties, specified as an mlreportgen.report.BaseTable object. The default value of this property is a BaseTable object with the TableStyleName property set to the BusObjectPropertiesTable style, which is defined in the default template for a BusObject reporter.

To customize the appearance of the table, modify the properties of the default table reporter or replace it with a customized table reporter. If you add content to the Title property of the default or customized table reporter, the content appears in front of the table title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

ElementsTableReporter — Table reporter for bus element properties

mlreportgen.report.BaseTable

Table reporter used to format the table of bus element properties, specified as an mlreportgen.report.BaseTable object. The default value of this property is a BaseTable object with the TableStyleName property set to the BusObjectElementsTable style, which is defined in the default template for a BusObject reporter.

To customize the appearance of the table, modify the properties of the default table reporter or replace it with a customized table reporter. If you add content to the Title property of the default or customized table reporter, the content appears in front of the table title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

HorizontalElementsTable — Whether to display element properties horizontally

0 (false) (default) | 1 (true)

Whether to display properties horizontally in the table of element properties, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The table has one column for each property. For example:

  

• 0 (false) — The property and value cells in the row for the element are split into multiple rows. For example:

  

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

SectionReporter — Section reporter

mlreportgen.report.Section

Reporter for formatting sections when the CreateSections property is set to true, specified as an mlreportgen.report.Section object. To customize the appearance of the section, modify the properties of the default section reporter or replace it with a customized section reporter.

Attributes:

GetAccess	public
SetAccess	public

PropertyFilterFcn — Function or expression to filter properties of a reported bus or bus element

[] (default) | function handle | string scalar | character vector

Function or expression to filter the properties of a reported bus or bus element from a report. Specify a function as a function handle. Specify an expression as a character vector or string scalar.

If you provide a function handle, the associated function must:

• Take these arguments:

  • variableName — Name of the model variable that designates the bus or bus element being reported

  • variableObject — The bus or bus element being reported

  • propertyName — Name of the property of the bus or bus element being reported

• Return true to filter the specified property from the report, or false to include the property in the report.

For example, this code prevents the display of the HeaderFile and Description properties of a bus object and the Complexity property of a bus element:

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

rpt = slreportgen.report.Report("busrpt","pdf");

model = "slrgex_sldemo_bus_arrays";
openExample(model); 

modelVariableFinder = ModelVariableFinder(model);
results = find(modelVariableFinder);
for result = results
    if isa(getVariableValue(result),"Simulink.Bus")
        busRptr = slreportgen.report.BusObject(result);
        busRptr.PropertyFilterFcn = @busPropertyFilter;
        % Create a Chapter
        chapter = mlreportgen.report.Chapter(busRptr.Name);
        add(chapter, busRptr);   
        add(rpt,chapter)
    end
end
close(rpt);

close_system(model);
rptview(rpt);

function tf = busPropertyFilter(~, variableObject,propertyName)
if isa(variableObject, "Simulink.Bus")
    tf = (propertyName == "HeaderFile") ||  ...
        (propertyName == "Description");
else
    % Filter Simulink.BusElement Complexity property
    tf = propertyName == "Complexity";
end
end

Note

You must run this code from a script since functions can only be created as local or nested functions in code files.

If you provide a string scalar or a character vector, it must contain an expression. The expression:

• Can use the variables variableName, variableObject, and propertyName

• Must set the variable isFiltered to true to filter the specified property from the report, or false to include the property in the report

For example, this code filters the HeaderFile property of a bus object from the report:

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

rpt = slreportgen.report.Report("busrpt","pdf");

model = "slrgex_sldemo_bus_arrays";
openExample(model); 

modelVariableFinder = ModelVariableFinder(model);
results = find(modelVariableFinder);
for result = results
    if isa(getVariableValue(result),"Simulink.Bus")
        busRptr = slreportgen.report.BusObject(result);
        busRptr.PropertyFilterFcn = "isFiltered = " + ...
            "isa(variableObject, ""Simulink.Bus"") && " + ...
            "propertyName == ""HeaderFile"";";
        % Create a Chapter
        chapter = mlreportgen.report.Chapter(busRptr.Name);
        add(chapter, busRptr);   
        add(rpt,chapter)
end
end
close(rpt);

close_system(model);
rptview(rpt);

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string | function_handle

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true
Dependent	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
slreportgen.report.BusObject.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.BusObject.customizeReporter	Create reporter from slreportgen.report.BusObject class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.BusObject at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.BusObject.getClassFolder	Get location of folder that contains slreportgen.report.BusObject class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Report on Bus Objects Using Bus Object Reporters

Report on bus objects in a model by using a model variable finder to find all variables used in the model and then creating a bus reporter for each variable that is a bus object.

% Create a Report
rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

% Load a model
model = "slrgex_sldemo_bus_arrays"; 
openExample(model);

% Find all variables used by the model
finder = slreportgen.finder.ModelVariableFinder(model);

% Create a Bus object reporter object for all results representing a
% Simulink.Bus object
while hasNext(finder)
    result = next(finder);
    if isa(getVariableValue(result), "Simulink.Bus")
        % Create a Bus object reporter
        busReporter = slreportgen.report.BusObject(result);
        % Create a Chapter
        chapter = mlreportgen.report.Chapter(busReporter.Name);
        % Add bus to chapter
        add(chapter, busReporter)
        % Add chapter to the report
        add(rpt,chapter);
    end
end

% Close and view the report
close(rpt);
rptview(rpt);

Customize the Reported Content and Formatting for Bus Objects

Customize the reported content and formatting of the content by setting properties of the bus object reporter. This example uses the ReportedElementProperties property to constrain the element properties that are reported. It uses the HorizontalElementsTable property to generate a properties table with one column for each property.

% Create a Report
rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

% Load a model
model = "slrgex_sldemo_bus_arrays"; 
openExample(model);

% Find all variables used by the model
finder = slreportgen.finder.ModelVariableFinder(model);

% Create a Bus object reporter object for all results representing a
% Simulink.BusObject object
while hasNext(finder)
    result = next(finder);
    if isa(getVariableValue(result), "Simulink.Bus")
        % Create a Bus object reporter
        busReporter = slreportgen.report.BusObject(result);
        % Limit the properties that are reported
        busReporter.ReportedElementProperties = {"Name","DataType","Min","Max"};
        % Display element properties horizontally
        busReporter.HorizontalElementsTable = true;
        % Create a Chapter
        chapter = mlreportgen.report.Chapter(busReporter.Name);
        % Add bus to chapter
        add(chapter, busReporter)
        % Add chapter to the report
        add(rpt,chapter);
    end
end

% Close and view the report
close(rpt);
rptview(rpt);

Version History

Introduced in R2019b