slreportgen.report.ElementDiagram.customizeReporter

Class: slreportgen.report.ElementDiagram
Namespace: slreportgen.report

Create custom element diagram reporter class

Syntax

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


Description

reporter = slreportgen.report.ElementDiagram.customizeReporter(classpath) creates an empty element diagram class definition file that is a subclass of slreportgen.report.ElementDiagram. The file is created at the specified classpath location. The customizeReporter method also copies the default element diagram templates to the <classpath>/resources/template folder. You can use the new class definition file as a starting point to design a custom element diagram 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 character vector or string scalar.

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

Create a custom element diagram reporter and associated default templates. The customizeReporter method creates the class file MyDiagram.m in this folder:

<current working folder>/newDiagram/@MyDiagram/MyDiagram.m

The default element diagram templates are in this folder:

<current working folder>/newDiagram/@MyDiagram/resources/templates

path = fullfile("newDiagram","@MyDiagram");
slreportgen.report.ElementDiagram.customizeReporter(path);

After editing the new class file and loading a model, you can use the new element diagram reporter.

openExample("sf_car");
diagram = MyDiagram('sf_car');

Version History

Introduced in R2018b