slreportgen.report.EnumerationType.customizeReporter

Class: slreportgen.report.EnumerationType
Namespace: slreportgen.report

Create custom subclass of slreportgen.report.EnumerationType class

Since R2023b

Syntax

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


Description

reporter = slreportgen.report.EnumerationType.customizeReporter(classpath) creates an empty element diagram class definition file that is a subclass of slreportgen.report.EnumerationType at the location specified by classpath. The customizeReporter method also copies the default reporter templates to the <classpath>/resources/template folder. You can use the new class definition file as a starting point to design a custom enumeration type class for your report.

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 string scalar or character vector.

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

Attributes

Static

true

To learn about attributes of methods, see Method Attributes.

Examples

Create Custom Enumeration Type Reporter

1. Create a custom enumeration type reporter and its associated default templates. Create the derived class file at the specified path relative to the current working folder. In this case, the path to the myEnumTypeTable.m class file is <current working folder>/newEnumTypeTable/@myEnumTypeTable/myEnumTypeTable.m. The default lookup table reporter templates are in the <current working folder>/newEnumTypeTable/@myEnumTypeTable/resources/templates folder.

   import mlreportgen.report.*
   import slreportgen.report.*
   LookupTable.customizeReporter('newEnumTypeTable/@myEnumTypeTable');
   

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

   ettable = myEnumTypeTable();

Version History

Introduced in R2023b