Main Content

slreportgen.report.ScopeSnapshot.customizeReporter

Class: slreportgen.report.ScopeSnapshot
Namespace: slreportgen.report

Create custom subclass of slreportgen.report.ScopeSnapshot class

Since R2023b

expand all in page

Syntax

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

Description

reporter = slreportgen.report.ScopeSnapshot.customizeReporter(classpath) creates an empty element diagram class definition file that is a subclass of slreportgen.report.ScopeSnapshot 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 scope snapshot class for your report.

Input Arguments

expand all

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

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

Attributes

Statictrue

To learn about attributes of methods, see Method Attributes.

Examples

expand all

  1. Create a custom scope snapshot 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 myScopeSnapTable.m class file is <current working folder>/newScopeSnapTable/@myScopeSnapTable/myScopeSnapTable.m. The default lookup table reporter templates are in the <current working folder>/newScopeSnapTable/@myScopeSnapTable/resources/templates folder.

    import mlreportgen.report.*
import slreportgen.report.*
ScopeSnapshot.customizeReporter('newScopeSnapTable/@myScopeSnapTable');

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

    sstable = myScopeSnapTable();

Version History

Introduced in R2023b

See Also

| |