slreportgen.finder.BlockResult class

Package: slreportgen.finder
Superclasses:

Create block finder result object

Description

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

Construction

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(Name,Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order. Enclose each property name in single quotes.

Input Arguments

block — Simulink or Stateflow^® block

block path | block handle

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

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"

DiagramPath — Path of block

string

This read-only property returns the path of the block returned in this result.

Tag — Additional information

string | character vector | object | ...

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

Methods

getDiagramReporter	Returns Diagram reporter for this block result
getReporter	Get block reporter

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.