Main Content

slreportgen.finder.BlockResult Class

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

Create block finder result object

expand all in page

Description

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

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

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

Input Arguments

expand all

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

Properties

expand all

Public Properties

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

Attributes:

NonCopyable
true

Protected Properties

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

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

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

Example: "Gain"

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

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

Methods

expand all

Version History

Introduced in R2017b

See Also

|

Topics