slreportgen.finder.SignalFinder Class

Namespace: slreportgen.finder
Superclasses: mlreportgen.finder.Finder

Find signals used by model or block

Since R2021a

Description

Use an object of the slreportgen.finder.SignalFinder class to find signals used by a model or block.

Signals are the outputs of dynamic systems that are represented by blocks in a Simulink^® diagram and by the diagram itself. To find unique signals in a system, the signal finder searches for block output ports. When a block or subsystem is searched, the results represent the output ports of the block or subsystem, as well as the output ports of the blocks whose output signals feed into the block or subsystem. When a model is searched, the results represent the output ports of the model Inport blocks and the block output ports that are connected to the model Outport blocks.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

finder = slreportgen.finder.SignalFinder(container) creates a SignalFinder object and sets the Container property to the model or block specified by container. Use the SignalFinder properties to:

• Constrain the search to the types of signals found, such as input, output, or internal signals.

• Specify the number of levels to search in a model.

Use the SignalFinder methods to perform the search.

Note

This finder provides these options 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.SignalFinder(Name=Value) sets the SignalFinder object properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

Container — Model or block to search for signals

string scalar | character vector | handle | slreportgen.finder.DiagramResult object | slreportgen.finder.BlockResult object

Model or block to search for signals, specified as one of the following values:

• A character vector or string scalar that contains the name of a model or block

• The handle of a model or block

• slreportgen.finder.DiagramResult or slreportgen.finder.BlockResult object

IncludeInputSignals — Whether to find signals used as input to model or block

true (default) | false

Whether to find the signals used as input data to the container model or block, specified as true or false. If Container is a model, the input signal results represent the output ports of any Inport blocks in the top level of the model. If Container is a block, the input signal results represent the output ports of the blocks that feed into the container block input ports.

IncludeOutputSignals — Whether to find signals output by model or block

true (default) | false

Whether to find signals output by the container model or block, specified as true or false. If Container is a model, the output signal results represent the output ports of blocks that feed into Outport blocks in the top level of the model. If Container is a block, the output signal results represent the output ports of the block.

IncludeControlSignals — Whether to find block control signals

false (default) | true

Whether to find block control signals, specified as true or false. This property applies only when Container is a block, such as a Subsystem or Model block, that has a control port. Control signals control the execution of a block. Control signal results represent the output ports of blocks that feed into a block control port, such as the enable, trigger, or reset port. If Container is a model, any signals that control the execution of blocks in the model are reported as internal signals.

IncludeInternalSignals — Whether to find internal signals

false (default) | true

Whether to find internal signals, specified as true or false. Internal signals are not used as input, output, or control signals for a model or subsystem. This property applies only if the Container is a model or subsystem. Internal signal results represent the output ports of all blocks in the system, except for the output ports of Inport blocks and output ports that feed into Outport blocks.

IncludeVirtualBlockSignals — Whether to find signals output by virtual blocks

true (default) | false

Whether to find signals output by virtual blocks, specified as true or false.

If this property is true, signal results can represent ports of virtual blocks, such as virtual Subsystem blocks.

If this property is false, signal results represent only output ports of nonvirtual blocks. Input and control signals are traced to the nonvirtual blocks that output the signal. If the model or block specified by the Container property is virtual, output ports of the model or block are traced to their nonvirtual sources.

IncludeUnnamedSignals — Whether to find signals without a name

true (default) | false

Whether to find signals without a name, specified as true or false.

SearchDepth — Number of levels to search for internal signals

1 (default) | 0 | positive integer | Inf

Number of levels to search for internal signals in the model or subsystem, specified as one of these values:

• 1 — Search level one (top level) only.

• 0 — Search only for signals that are related to the ports of the model or block.

• An integer n that is greater than one — Search the specified number of levels. The results are sorted from level one (top) to level n.

• Inf — Search all levels.

See IncludeInternalSignals.

SortType — Sorting method for finder results

"depth" (default) | "alphabetical" | "systemAlpha"

Sorting method for finder results, specified as one of these values:

Value	Description
"depth"	Sort results by depth in the model hierarchy. The first result in the sorted list belongs to the object that is highest in the hierarchy. For example, a model and its subsystems are sorted in the order: myModel, myModel/subsystem1, myModel/subsystem1/nestedSubststem.
"alphabetical"	Sort results alphabetically by name.
"systemAlpha"	Sort results alphabetically by parent system name.

Properties — Properties of output ports to find

{} (default) | cell array

Properties of output ports to find, specified as a cell array of name-value arguments. The finder returns only output ports that have the specified properties with the specified values.

Example: {"CompiledPortDataType","int8"}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Public Methods

find	results = find(finder) finds signals in a model or subsystem according to the constraints specified by the finder. The variables are returned as an array of slreportgen.finder.SignalResult 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 signal by setting the properties of the signal reporter. Get the reporter by using the getReporter method of the slreportgen.finder.SignalResult object that represents the signal.
hasNext	tf = hasNext(finder) returns true if a signal returned by the finder is available for the next method to retrieve. If the finder does not return any signals, or if all signals have been retrieved, hasNext returns false. Use hasNext and next to iterate through the signals in a while loop. In the loop, you can customize the content and formatting for a signal by setting properties of the signal reporter. Get the reporter by using the getReporter method of the slreportgen.finder.SignalResult object.
next	result = next(finder) returns the next signal as an slreportgen.finder.SignalResult object. Use hasNext and next to iterate through found signals in a while loop. In the loop, you can customize the content and formatting for a signal by setting the properties of the signal reporter. Get the reporter by using the getReporter method of the slreportgen.finder.SignalResult object.

Examples

Find and Report Signals in a Model

Create a report that includes information about signals in a model by using an slreportgen.finder.SignalFinder object. Set the finder properties so that signals without names are excluded and internal signals are included.

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

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

Create a Simulink report.

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

Create a chapter for the signal information.

chapter = Chapter();
chapter.Title = "Named Signals";

Load the vdp model.

model_name = "vdp";
load_system(model_name);

Create a signal finder and set the properties to exclude signals without names and include internal signals.

finder = SignalFinder(model_name);
finder.IncludeUnnamedSignals = false;
finder.IncludeInternalSignals = true;

Find the signals and add the results to the chapter.

results = find(finder);
append(chapter,results);

Add the chapter to the report.

append(rpt,chapter);

Close and view the report.

close(rpt);
rptview(rpt);

Version History

Introduced in R2021a