slreportgen.finder.DiagramResult class

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

Create diagram result finder object

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

diagram — Simulink or Stateflow diagram

diagram path | diagram handle

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

Properties

Object — Diagram handle

handle

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

Name — Name of model or block

string

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

Type — Diagram type

string

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

Example: "Simulink.BlockDiagram"

Path — Path to diagram

string

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"

Tag — Additional information

string | character vector | object | ...

Additional information to add to this result. You can set it to any type of value.

Methods

Public Methods

getDefaultSummaryProperties	propList = getDefaultSummaryProperties(resultObject,TypeSpecificProperties) returns the list of finder result class properties that are included by default in a summary table.
getDefaultSummaryTableTitle	tableTitle = getDefaultSummaryTableTitle(resultObject,TypeSpecificTitle) returns the default title for a summary table for a finder result object of type resultObject.
getPropertyValues	propVals = getPropertyValues(resultObject,propNames) returns the values of the properties specified in propNames in a cell array. Access the properties of the result object or the diagram represented by the finder result object by specifying the required property names in propNames.
getReporterLinkTargetID	targetID = getReporterLinkTargetID(resultObject) returns the link target ID of the reporter associated with the finder result object. Use the link target ID to add a hyperlink to the reporter from any part of the report.

Version History

Introduced in R2017b