slreportgen.utils.isDocBlock

Check if DocBlock

Since R2019a

Syntax

tf = slreportgen.utils.isDocBlock(obj)

Description

tf = slreportgen.utils.isDocBlock(obj) tests if the input obj is a Simulink^® DocBlock block.

Examples

Test If Object Is a DocBlock

Run the following command to access the supporting files used in this example.

openExample('rptgenext/SimulinkReportGeneratorFilesExample');

load_system("slrgex_fuelsys")
tf = slreportgen.utils.isDocBlock ...
   ("slrgex_fuelsys/To Controller/Sensor Info")

tf =

  logical

   1

In this case, the Sensor Info block in the sldemo_fuelsys model is a DocBlock.

Input Arguments

obj — Object to test for being a DocBlock

string | character array | handle

Object to test for being a DocBlock, specified as a string or character array of the block path or handle.

Output Arguments

tf — Whether input is a DocBlock

true | false

Whether input is a DocBlock, returned as 1 (true) if the input is a DocBlock. Otherwise, it returns 0 (false).

Version History

Introduced in R2019a