slreportgen.finder.StateflowObjectFinder Class

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

Find Stateflow objects

Since R2023a

Description

Use objects of the slreportgen.finder.StateflowObjectFinder class to find objects in a Stateflow^® chart diagram. You can use these objects to search for:

• Path or handle to a Simulink^® model

• Path or handle to a Stateflow chart block

• Stateflow.Chart objects

• Stateflow.State objects

• Stateflow.Machine objects

• slreportgen.finder.StateflowObjectFinder objects that represent a model, Stateflow chart, Stateflow state, or Stateflow machine object

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

Creation

Description

finder = StateflowObjectFinder(diagram) creates a Stateflow object finder object. Use the properties of the finder to constrain the search to specific types of objects.

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

Properties

Container — Chart diagram to search

path | handle | chart ID | Stateflow.Chart object

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

• Path or handle to a Simulink model

• Path or handle to a Stateflow chart block

• Stateflow.Chart objects

• Stateflow.State objects

• Stateflow.Machine objects

• slreportgen.finder.StateflowObjectFinder objects that represent a model, Stateflow chart, Stateflow state, or Stateflow machine object

Types — Types of diagram elements to find

"all" (default) | string | character array | array of strings | cell array of character arrays

Types of Stateflow diagram objects to find, specified as a string, character array, array of strings, or a cell array of character arrays that contain either these fully qualified or short names in this table:

Fully Qualified Name	Short Name
All	all
Stateflow.Annotation	annotation
Stateflow.Box	box
Stateflow.EMFunction	emfunction
Stateflow.Function	function
Stateflow.Junction	junction
Stateflow.Port	port
Stateflow.SLFunction	slfunction
Stateflow.State	state
Stateflow.Transition	transition
Stateflow.TruthTable	truthtable
Stateflow.Data	data
Stateflow.Event	event

If the type is an array, it specifies a set of element types. The default is All or all, which finds all objects in all diagrams. Use one of these values to constrain the search to specific diagram object types.

IncludeCommented — Include commented-out chart elements

false (default) | true

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

SearchDepth — Number of levels to search Container

1 (default) | Inf | nonnegative integer

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

Value	Description
1 (default)	Search only for objects visible from the top level of the chart. The search includes objects in nested states but excludes objects 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 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 = {"ArrowSize","5"}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Public Methods

Method	Description
find	results = find(finder) finds Stateflow objects in the Stateflow object specified by the Container property of the StateflowObjectFinder object, finder. This method returns the Stateflow objects that it finds wrapped in result objects of type slreportgen.finder.StateflowObjectResult. To report on objects found by the finder, append the result objects to objects found by the finder, append the result objects to a report or reporter object. You can add the results only to reports of type slreportgen.report.Report.
hasNext	tf = hasNext(finder) returns a logical 1 (true) if a result object is available to be retrieved by the next method. If no result object is available, hasNext returns a logical 0 (false). Use the next method to obtain that object. A result object is available if it matches the finder properties and has not been previously retrieved by the next method. Use this method with the next method in a while-loop to progressively search a container for objects.
next	result = next(finder) returns the next search result as an slreportgen.finder.StateflowObjectResult class. If no result object is available, then the next method returns an empty StateflowObjectResult object. To report on objects found by the finder, append the result objects to an slreportgen.report.Report object.

Examples

Find Stateflow Data and Events

Create a report that finds Stateflow data and events in the shift_logic Stateflow chart within the sf_car model.

First, import the report API namespaces so that you do not have to use long fully qualified class names.

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

Load your Simulink model and create a PDF report.

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

Find all data and events in the shift_logic chart.

objFinder = StateflowObjectFinder("sf_car/shift_logic");
objFinder.Types = ["data", "event"];
results = find(objFinder);

Add the results to your report.

append(rpt,results);

Close the model and view your report.

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

Version History

Introduced in R2023a