slreportgen.finder.BlockFinder Class

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

Find Simulink blocks

Description

Finds blocks in a Simulink^® diagram.

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

Creation

Description

finder = BlockFinder(diagram) creates a finder that finds by default all types of blocks in the specified Simulink block diagram. To constrain the search to specific types of blocks, use the properties of the finder.

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 = BlockFinder(Name=Value) sets properties using name-value arguments. You can specify multiple name-value arguments in any order.

Input Arguments

diagram — Block diagram to search

path | handle

See Container property.

Properties

Container — Diagram to search

path | handle

Diagram in which to search, specified as one of these values:

• Handle to a Simulink model or subsystem

• Path to a Simulink model or subsystem

BlockTypes — Types of blocks to find

string | character array | string array | cell array of character arrays

Type of block to find, such as Gain, specified as a string or character array, or a set of block types to find, specified as a string array or a cell array of character arrays.

IncludeCommented — Include commented-out blocks

false (default) | true

Whether to include commented-out blocks in the search results, specified as a logical. If false, commented-out blocks are excluded from the search results.

IncludeVariants — Variants to include

"Active" (default) | "All" | "ActivePlusCode"

Variants of a variant block to include in the search results, specified as one of these values:

Value	Description
"Active"	Active variants
"All"	All variants
"ActivePlusCode"	Active variants and code variants

Data Types: char | string

SearchDepth — Number of levels to search Container

1 (default) | Inf | nonnegative integer

Number of levels to search Container, specified as a nonnegative integer or Inf. Specify Inf to search all levels.

SortType — Sorting method for finder results

"none" (default) | "alphabetical" | "systemAlpha" | "fullPathAlpha" | "blockType" | "depth" | "leftToRight" | "topToBottom" | "runtime"

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

Value	Description
"none"	Do not sort results.
"alphabetical"	Sort results alphabetically by name.
"systemAlpha"	Sort results alphabetically by parent system name.
"fullPathAlpha"	Sort results alphabetically by full path.
"blockType"	Sort results alphabetically by type.
"depth"	Sort results by depth in the model hierarchy. The first result in the sorted list belongs to the system that is highest in the hierarchy. For example, a result in the top-level model and blocks in subsystems are sorted in the order: myModel/block1, myModel/subsystem1/block2, myModel/subsystem1/nestedSubststem/block3.
"leftToRight"	Sort results by their location in the model layout using rows from left to right. A row of blocks in the model is a subgroup of blocks that are positioned between two horizontal lines. A minimal row is a row that cannot be divided to subrows. The algorithm first groups the blocks into minimal rows and sorts each row from left to right. The algorithm then concatenates the sorted rows from top to bottom.
"topToBottom"	Sort results by their location in the model layout using columns from top to bottom. A column of blocks in the model is a subgroup of blocks that are positioned between two vertical lines. A minimal column is a column that cannot be divided to subcolumns. The algorithm first groups the blocks into minimal columns and sorts each row from top to bottom. The algorithm then concatenates the sorted rows from right to left.
"runtime"	Sort nonvirtual blocks by their order of execution in a model or nonvirtual subsystem. This option compiles the model containing the specified blocks. Any block result that represents a virtual block or a block that is not a part of the system specified by Container is appended to the end of the sorted block list. For multitasking systems, blocks are grouped by the task in which they execute.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

ConnectedSignal — Limit search to blocks connected to specific signal

[] (default) | slreportgen.finder.SignalResult | port handle

Limit the search to blocks that are connected to a specific signal, specified as an slreportgen.finder.SignalResult object or port handle. If this property is empty, the search is not limited to blocks that are connected to specific signals.

Example: finder.ConnectedSignal = find_system(my_model,findall=true,type="port",name="my_signal")

Attributes:

GetAccess	public
SetAccess	public

Properties — Properties of objects to find

cell array

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

Example: finder.Properties = {'Gain','5'}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Public Methods

Method	Description
find	results = find(finder) finds blocks in the diagram specified by the finder. This method returns the blocks it finds wrapped in result objects of type slreportgen.finder.BlockResult. To add tables of the block properties, add the results objects directly to the report or add them to a reporter that you then add to a report. The reports to which you can add the results of this method must be of reports of type slreportgen.report.Report
hasNext	tf = hasNext(finder) determines if the diagram that the finder searches contains at least one block. If the diagram has at least one block, the hasNext method queues that block as the next block that the next method will return. The hasNext method then returns true. Use the next method to obtain that block. On subsequent calls, the hasNext method determines if the diagram has a block that the next method has not yet retrieved. It queues the block for the next method to retrieve and returns true. If there are no more blocks to be retrieved, this method returns false. To search a diagram progressively for blocks, use the hasNext method with the next method in a while loop.
next	result = next(finder) returns the next search result in the result queue that the hasNext method created. This method returns the block that it finds wrapped in a result object of type slreportgen.finder.BlockResult. To add tables of the block properties, add the result object to the report directly or add it to a reporter that you then add to a report. The reports to which you can add the results of this method must be of type slreportgen.report.Report.

Examples

Find Inport and Outport Blocks in a Model

Find Inport and Output blocks in the sf_car model.

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

model_name = "sf_car";
load_system(model_name)
rpt = slreportgen.report.Report("output","pdf");

add(rpt,TitlePage(Title="I/O Blocks in "+model_name+" Model"));
add(rpt,TableOfContents);

diagFinder = SystemDiagramFinder(model_name);
diagFinder.IncludeRoot = false;
while hasNext(diagFinder)
    diagram = next(diagFinder);
    chapter = Chapter(Title=diagram.Name);
    add(chapter,diagram)
    sect = Section(Title="Inport Blocks");
    ioFinder = BlockFinder(diagram.Object);
    ioFinder.BlockTypes = "Inport";
    blocks = find(ioFinder);
    for block = blocks
        add(sect,block)
    end  
    add(chapter,sect);
    sect = Section(Title="Outport Blocks");
    ioFinder = BlockFinder(diagram.Object);
    ioFinder.BlockTypes = "Outport";
    outblocks = find(ioFinder);
    for block = outblocks
        add(sect,block)
    end  
    add(chapter,sect)
    add(rpt,chapter)
end
close(rpt)
close_system(model_name)
rptview(rpt)

Version History

Introduced in R2017b