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
creates a search result object for a result
= BlockResult(block
)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.
sets properties using name-value pairs. You can specify multiple name-value pair
arguments in any order.finder
= BlockResult(Name=Value
)
Input Arguments
Properties
Methods
Public Methods
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 . |
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. |
Copy Semantics
Handle. To learn how handle classes affect copy operations, see Copying Objects.