Main Content

slreportgen.report.CCaller.customizeReporter

Class: slreportgen.report.CCaller
Namespace: slreportgen.report

Create class derived from C Caller block reporter class

Since R2022a

expand all in page

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

expand all

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

expand all

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

ValueDescription
slreportgen.report.CCaller.customizeReporter("myFolder/MyClass")Create MyClass.m in the subfolder myFolder of the current folder.
slreportgen.report.CCaller.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.CCaller.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

expand all

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

Version History

Introduced in R2022a

See Also

| | | |