Main Content

slreportgen.finder.DiagramResult class

Package: slreportgen.finder
Superclasses: mlreportgen.finder.Result

Create diagram result finder object

expand all in page

Description

Diagram search result object for a Simulink® or Stateflow® diagram.

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

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

Creation

Description

result = DiagramResult(diagram) creates a search result object for a Simulink or Stateflow diagram. The result object contains the specified Simulink or Stateflow diagram. Diagram finder find methods create and return instances of this object for each diagram that they find. You do not need to create this object yourself.

Input Arguments

expand all

Simulink or Stateflow diagram, specified by its path or its handle.

Properties

expand all

Public Properties

Additional user-defined information to add to the result, specified as any value.

Attributes:

NonCopyable
true

Data Types: any

Protected Properties

This read-only property contains a handle to the diagram returned by this result.

This read-only property specifies the name of the model or block that contains the diagram returned by this result.

This read-only property specifies the type of the diagram returned by this result.

Example: "Simulink.BlockDiagram"

This read-only property returns the path of the container of the diagram returned by this result. An example of a container of a diagram is a subsystem block.

Example: "slrgex_sf_car/Engine"

Methods

expand all

Version History

Introduced in R2017b

See Also

| | |

Topics