slreportgen.finder.DiagramElementFinder Class

Namespace: slreportgen.finder

Create diagram element finder object

Description

Finds elements in a Simulink^® block or Stateflow^® chart diagram.

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

Creation

Description

finder = DiagramElementFinder(diagram) creates a finder that finds elements of a Simulink block or Stateflow chart diagram. By default this finder finds blocks, annotations, lines, states, and other elements in the diagram. Use the properties of the finder to constrain the search to specific types of elements.

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.

example

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

Input Arguments

expand all

`diagram` — Diagram to search
path | handle | chart ID | chart object

See Container property.

Properties

expand all

`Container` — Diagram to search
path | handle | chart ID | chart object

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

Handle to a Simulink block
Path to a Simulink block
Handle to a Stateflow chart block
Path to a Stateflow chart block
Stateflow chart ID
Stateflow chart object

`Types` — Types of diagram elements to find
string | character array | array of strings | cell array of character arrays

Types of Simulink or Stateflow diagram elements to find, specified as a string, character array, array of strings, or a cell array of character arrays. If the type is an array, it specifies a set of element types. The default is All or all, which finds all elements in all diagrams. Use one of these values to constrain the search to specific diagram element types. You can use either the fully qualified name or the short name.

Fully Qualified Name	Short Name
`All`	`all`
`Simulink.Annotation`	`annotation`
`Simulink.Block`	`block`
`Simulink.Segment`	`line`
`Simulink.Port`	`port`
`Stateflow.Annotation`	`sf_annotation`
`Stateflow.Box`	`box`
`Stateflow.EMFunction`	`emfunction`
`Stateflow.Function`	`function`
`Stateflow.Junction`	`junction`
`Stateflow.Port`	`sf_port`
`Stateflow.SLFunction`	`slfunction`
`Stateflow.State`	`state`
`Stateflow.Transition`	`transition`
`Stateflow.TruthTable`	`truthtable`

`IncludeCommented` — Include commented-out diagram elements
`false` (default) | `true`

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

`IncludeVariants` — Include diagram variants
string | character vector

Variants to search for diagrams, specified as a string or character vector. The default value is Active. Valid values are:

All — All variants
Active — Only active variants
ActivePlusCode — All active variants and code variants

`SearchDepth` — Number of levels to search `Container`
`[]` (default) | `inf` | nonnegative integer

Number of levels to search Container, specified as one of these values:

Value	Description
`[]` (default)	If `Container` is a block diagram, search only the top level of the diagram. If `Container` is a Stateflow chart diagram, search only for elements visible from the top level of the chart. The search includes elements in nested states but excludes elements in subcharts.
nonnegative integer	Search the specified number of levels
`inf`	Search all levels

`SortType` — Sort finder results
`none` (default) | `"alphabetical"` | `"systemAlpha"` | `"depth"`

Sort 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.
`"depth"`	Sort results by depth in the model hierarchy. The first result in the sorted list belong 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`

`Properties` — Properties of objects to find
cell array

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

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

Methods

expand all

Public Methods

Method	Description
`find`	`results = find(finder)` finds diagram elements in the `diagram` specified by the finder. This method returns the diagram elements it finds wrapped in result objects of type `slreportgen.finder.DiagramElementResult`. To add tables of the diagram element 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 reports of type `slreportgen.report.Report`.
`hasNext`	`tf = hasNext(finder)` determines if the diagram that the finder searches contains at least one element. If the diagram has at least one element, the `hasNext` method queues that element as the next element that the `next` method will return. The `hasNext` method then returns `true`. Use the `next` method to obtain that element. On subsequent calls, the `hasNext` method determines if the diagram has an element that the `next` method has not yet retrieved. It queues the element for the `next` method to retrieve and returns `true`. If there are no more elements exist to be retrieved, this method returns `false`. To search a diagram progressively for elements, 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 diagram element that it finds wrapped in a result object of type `slreportgen.finder.DiagramElementResult`. To add tables of the diagram element 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 type `slreportgen.report.Report`.

Examples

collapse all

Find Block, Annotation, and Line Elements

Find the block, annotation, and line diagram elements to a search depth of 1 in the f14 model.

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

model_name = "f14";
openExample(model_name);

rpt = slreportgen.report.Report("output","pdf");
add(rpt, TitlePage(Title=sprintf("%s Model",model_name)));
add(rpt, TableOfContents);

diagFinder = SystemDiagramFinder(Container=model_name,SearchDepth=1);
while hasNext(diagFinder)
    system = next(diagFinder);
    chapter = Chapter(Title=system.Name);
    add(chapter,system);
    sect = Section(Title="Diagram Elements");
    elemFinder = DiagramElementFinder(...
                        Container=system.Object,...
                        Types=["block" "annotation" "line"]);
    elems = find(elemFinder);
    for elem = elems
        add(sect, elem);
    end  
    add(chapter, sect);
    add(rpt, chapter);
end

close(rpt);
close_system(model_name);
rptview(rpt);

Version History

Introduced in R2017b

slreportgen.finder.DiagramElementFinder Class

Description

Creation

Description

Input Arguments

`diagram` — Diagram to search
path | handle | chart ID | chart object

Properties

`Container` — Diagram to search
path | handle | chart ID | chart object

`Types` — Types of diagram elements to find
string | character array | array of strings | cell array of character arrays

`IncludeCommented` — Include commented-out diagram elements
`false` (default) | `true`

`IncludeVariants` — Include diagram variants
string | character vector

`SearchDepth` — Number of levels to search `Container`
`[]` (default) | `inf` | nonnegative integer

`SortType` — Sort finder results
`none` (default) | `"alphabetical"` | `"systemAlpha"` | `"depth"`

`Properties` — Properties of objects to find
cell array

Methods

Public Methods

Examples

Find Block, Annotation, and Line Elements

Version History

See Also

Topics

slreportgen.finder.DiagramElementFinder Class

Description

Creation

Description

Input Arguments

diagram — Diagram to search path | handle | chart ID | chart object

Properties

Container — Diagram to search path | handle | chart ID | chart object

Types — Types of diagram elements to find string | character array | array of strings | cell array of character arrays

IncludeCommented — Include commented-out diagram elements false (default) | true

IncludeVariants — Include diagram variants string | character vector

SearchDepth — Number of levels to search Container [] (default) | inf | nonnegative integer

SortType — Sort finder results none (default) | "alphabetical" | "systemAlpha" | "depth"

Properties — Properties of objects to find cell array

Methods

Public Methods

Examples

Find Block, Annotation, and Line Elements

Version History

See Also

Topics

`diagram` — Diagram to search
path | handle | chart ID | chart object

`Container` — Diagram to search
path | handle | chart ID | chart object

`Types` — Types of diagram elements to find
string | character array | array of strings | cell array of character arrays

`IncludeCommented` — Include commented-out diagram elements
`false` (default) | `true`

`IncludeVariants` — Include diagram variants
string | character vector

`SearchDepth` — Number of levels to search `Container`
`[]` (default) | `inf` | nonnegative integer

`SortType` — Sort finder results
`none` (default) | `"alphabetical"` | `"systemAlpha"` | `"depth"`

`Properties` — Properties of objects to find
cell array