slreportgen.report.CCaller.customizeReporter

Class: slreportgen.report.CCaller
Package: slreportgen.report

Create class derived from C Caller block reporter class

Since R2022a

Syntax

reporter = slreportgen.report.CCaller.customizeReporter(classPath)


Description

reporter = slreportgen.report.CCaller.customizeReporter(classPath) creates a reporter class definition file that is a subclass of slreportgen.report.CCaller 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.

Examples

Create Custom C Caller Block Reporter

Create a custom reporter and its associated default templates. This function creates the derived class file at the specified path relative to the current working folder.

In this case, the path to the myCCallerReporter.m class file is <current_working_folder>/newCCallerReporter/@myCCallerReporter/myCCallerReporter.m.

slreportgen.report.CCaller.customizeReporter("myCCallerReporter/@myCallerReporter")

After editing this new class file, you can use it as your C Caller block reporter.

The default templates are in the <current_working_folder>/newCCallerReporter/@myCCallerReporter/resources/templates folder.

Input Arguments

classPath — Path and name of new class definition file

string scalar | character vector

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

Specify a relative path or an absolute path. For example, this code creates myCCallerReporter.m in the subfolder sFolder1 of the current folder.

slreportgen.report.CCaller.customizeReporter("sFolder1/myCCallerReporter")

To create the reporter class in a class folder, precede the class name with the @ character. Do not specify the .m extension. For example, this code creates myClass.m in the subfolder sFolder2/@myClass in the current folder.

slreportgen.report.CCaller.customizeReporter("sFolder2/@myClass")

See Folders Containing Class Definitions.

To create the reporter class in a package, precede the folder name with the + character. For example, this code creates a reporter in the myOrg package folder in the current folder.

slreportgen.report.CCaller.customizeReporter("+myOrg/@myClass")

Output Arguments

reporter — Path and file name of the new reporter class

string scalar

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

Version History

Introduced in R2022a