slreportgen.finder.AnnotationFinder Class

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

Find Simulink annotation objects

Description

Find annotation objects in a Simulink^® or Stateflow^® diagram.

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

Creation

Description

finder = AnnotationFinder(diagram) creates a finder that finds by default all annotations in the specified diagram. To constrain the search to specific types of annotations, 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 = AnnotationFinder(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 — 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

Attributes:

GetAccess	public
SetAccess	public

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

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, 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

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

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

Create a report that finds annotations 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="Annotations in "+model_name+" Model"));
add(rpt,TableOfContents);

diagFinder = SystemDiagramFinder(model_name);
diagrams = find(diagFinder);
while hasNext(diagFinder)
    diagram = next(diagFinder);
    annotFinder = AnnotationFinder(diagram.Object);
    annotations = find(annotFinder);
    if ~isempty(annotations)
        chapter = Chapter(Title=diagram.Name);
        add(chapter, diagram);
        sect = Section(Title="Annotations");       
        add(sect,annotations);
        add(chapter,sect);
        add(rpt,chapter);
    end
end

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

Version History

Introduced in R2017b