slreportgen.report.SummaryTable.customizeReporter

Class: slreportgen.report.SummaryTable
Namespace: slreportgen.report

Create class derived from summary table reporter class

Since R2022a

Syntax

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

Description

reporter = slreportgen.report.SummaryTable.customizeReporter(classpath) creates a reporter class definition file that defines a subclass of slreportgen.report.SummaryTable at the location specified by classPath. The method also copies the default reporter template to the resources/templates subfolder of the folder that contains the class definition file. Use the class definition file as a starting point to design a custom reporter class.

Input Arguments

classpath — Path and name of new class definition file

string scalar | character vector

Path and name of the new class definition file, specified as a character vector or string scalar.

Value	Description
slreportgen.report.SummaryTable.customizeReporter("myFolder/MyClass")	Create MyClass.m in the subfolder myFolder of the current folder.
slreportgen.report.SummaryTable.customizeReporter("myFolder/@MyClass")	Create the reporter class in a class folder by preceding the class name with the @ character. Do not specify the .m extension. See Folders Containing Class Definitions.
slreportgen.report.SummaryTable.customizeReporter("+myOrg/@MyClass")	Create the reporter class in a class namespace by preceding the folder name with the + character.

Note

You can specify a relative path or an absolute path.

Data Types: string | char

Output Arguments

reporter — Path and file name of new reporter class

string scalar

Path and file name of the new reporter class, returned as a string scalar.

Examples

Create Custom Summary Table Reporter

Create a derived class from the summary table reporter class and its associated default templates at the specified path in the current working folder.

Specify the path to the mySummaryTableReporter.m class file as <current_working_folder>/newSummaryTableReporter/@mySummaryTableReporter/mySummaryTableReporter.m.

slreportgen.report.SummaryTable.customizeReporter(...
"newSummaryTableReporter/@mySummaryTableReporter")

The default templates are in the <current_working_folder>/newSummaryTableReporter/@mySummaryTableReporter/resources/templates folder.

Version History

Introduced in R2022a