slreportgen.report.RptFile.customizeReporter

Class: slreportgen.report.RptFile
Package: slreportgen.report

Create custom Report Explorer-based reporter class

Syntax

reporter = slreportgen.report.RptFile.customizeReporter(classpath)

Description

reporter = slreportgen.report.RptFile.customizeReporter(classpath) creates a Report Explorer-based reporter (RptFile) class definition file that is a subclass of slreportgen.report.RptFile. The file is created at the specified classpath location. The RptFile.customizeReporter method also copies the default RptFile templates to the <classpath>/resources/template folder. You can use the new class definition file as a starting point to design a custom Report Explorer-based reporter class for your report.

Input Arguments

expand all

Location of custom Report Explorer-based reporter class, specified as a string or character array. The classpath argument also supports specifying a folder with @ before the class name.

Output Arguments

expand all

Report Explorer-based reporter path, returned as a string specifying the path to the derived report class file.

Examples

Create Custom Report Explorer-based Reporter

Create a custom Report Explorer-based reporter and its associated default templates. In this example, the derived class file is created at the specified path under the current working folder. In this example, the path to the MyRptExplRptr.m class file is <current working folder>/new_rptexpl_rptr/@MyRptExplRptr/MyRptExplRptr.m. The default RptFile templates are in the <current working folder>/new_rptexpl_rptr/@RptExplRptr/resources/templates folder.

import slreportgen.report.*
RptFile.customizeReporter('new_rptexpl_rptr/@MyRptExplRptr');

After editing this new class file, you can use it as your RptFile reporter.

rptr = MyRptExplRptr();

Introduced in R2019a