slreportgen.finder.BlockResult Class

R2026b

Namespace: slreportgen.finder
Superclasses: slreportgen.finder.DiagramElementResult

Create block finder result object

Description

Block search result object for a block in a Simulink^® diagram.

When you add a BlockResult object to a report or reporter, the object uses its getReporter method to generate a properties table for the block. If the block is a subsystem or chart, use the getDiagramReporter method to obtain a reporter that generates a snapshot of the block diagram or chart.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

result = BlockResult(block) creates a search result object for a block found by a BlockFinder. The result object contains the Simulink block.

Note

The simulink.finder.BlockFinder find method creates objects of this type for each block that it finds. You do not need to create this object yourself.

finder = BlockResult(PropertyName=Value) sets properties using name-value arguments. You can specify multiple name-value arguments in any order.

Input Arguments

block — Simulink or Stateflow^® block

block path | block handle

Simulink block, specified as a path or block handle to that block.

Properties

Public Properties

Tag — Additional user-defined information

[] (default) | string scalar | character vector | object | ...

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Protected Properties

Object — Block handle

handle

This read-only property contains a handle to the block returned in this result.

Name — Name of block

string

This read-only property specifies the name of the block returned in this result.

Type — Block type

string

This read-only property specifies the type of the block returned in this result.

Example: "Gain"

BlockPath — Path of block

string

This read-only property returns the path of the block in the model.

DiagramPath — Path of parent diagram

string

This read-only property returns the path to the model or subsystem that contains the block.

Methods

Public Methods

getDiagramReporter	reporter = getDiagramReporter(resultObject) returns a slreportgen.report.Diagram reporter if the block result contains a subsystem or chart block. Otherwise, returns empty, [].
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 block represented by the finder result object by specifying the required property names in propNames.
getReporter	reporter = getReporter(resultObject) returns a reporter that generates a properties table for the block in the result. If the Report API includes a block-specific reporter, returns that reporter. Otherwise, returns an slreportgen.report.SimulinkObjectProperties reporter.
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.
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