slreportgen.finder.StateFinder Class

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

Find Stateflow states

Description

Finds Stateflow^® states.

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

Creation

Description

finder = StateFinder(diagram) creates a finder that finds by default all uncommented Stateflow states in the specified chart diagram. To constrain the search to specific types of chart diagrams, use the properties of this 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 = StateFinder(Name=Value) sets properties using name-value arguments. You can specify multiple name-value arguments in any order.

Input Arguments

diagram — Diagram to search

path | handle | chart ID | chart object

See Container property.

Properties

Container — Chart diagram to search

path | handle | chart ID | chart object

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

• Handle to a Stateflow chart block

• Path to a Stateflow chart block

• Stateflow chart ID

• Stateflow chart object

IncludeCommented — Include commented-out states

false (default) | true

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

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)	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 object in the sorted list is 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.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

Properties — Properties of states to find

cell array

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

Example: finder.Properties = {"ArrowSize","5"}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Public Methods

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

Find Stateflow States

Create a report that includes properties of all the Stateflow states in the shift_logic chart of 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");
open(rpt)

add(rpt, TitlePage(Title="States in "+model_name+" Model"));
add(rpt, TableOfContents);

chartFinder = ChartDiagramFinder(model_name);
charts = find(chartFinder);
while hasNext(chartFinder)
    diagram = next(chartFinder);
    stFinder = StateFinder(diagram.Object);
    states = find(stFinder);
    if ~isempty(states)
        chapter = Chapter(Title=diagram.Name);
        add(chapter,diagram)
        for state = states
           sect = Section(Title="States");       
           add(sect,states)
        end
        add(chapter,sect)
        add(rpt,chapter)
    end
end

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

Version History

Introduced in R2017b