Main Content

getReporter

Class: slreportgen.finder.DiagramElementResult
Package: slreportgen.finder

Get diagram element reporter

Syntax

reporter = getReporter(result)

Description

reporter = getReporter(result) returns a reporter that generates a properties table for the diagram element returned in this result. A report or reporter to which a diagram element result is added invokes this method to generate a properties table for the element in the result. If you need to customize a properties table, you can invoke this method to get the properties reporter. Then, modify the reporter and add the modified properties reporter to the target report or reporter.

Input Arguments

expand all

Diagram element result object, specified as an slreportgen.finder.DiagramElementResult object.

Output Arguments

expand all

Diagram element reporter object, returned as one of these values:

  • Block-specific reporter object, when the diagram element is a block and the Report API includes a reporter for the block. For example, the getReporter method returns an slreportgen.report.DocBlock object when the search result represents a DocBlock block.

  • An slreportgen.report.SimulinkObjectProperties object for all other blocks and block diagram elements.

  • An slreportgen.report.StateflowObjectProperties object for Stateflow® chart elements.

Introduced in R2017b