Main Content

slreportgen.report.ElementDiagram.customizeReporter

Class: slreportgen.report.ElementDiagram
Package: slreportgen.report

Create custom element diagram reporter class

Since R2018b

expand all in page

Syntax

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

Description

customRptrPath = 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

expand all

Location of custom element diagram class, specified as a string or character array. The classpath argument also supports specifying a folder with @ before the class name. For example, both of these are valid paths:

  • slreportgen.report.ElementDiagram.customizeReporter("path_folder/MyClassA.m")

  • slreportgen.report.ElementDiagram.customizeReporter("+package/@MyClassB")

Output Arguments

expand all

Path of the custom element diagram reporter classdef file that defines the custom element diagram reporter, specified as a string.

Examples

Create Custom Element Diagram Reporter

Create a custom element diagram reporter and its associated default templates. The derived class file is created at the specified path relative to the current working folder. In this case, the path to the MyElemDiagram.m class file is <current working folder>/newElemDiagram/@MyElemDiagram/MyElemDiagram.m. The default diagram templates are in the <current working folder>/newDiagram/@MyElemDiagram/resources/templates folder.

import slreportgen.report.*
ElementDiagram.customizeReporter('newElemDiagram/@MyElemDiagram');

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

slrgex_sf_car;
diagram = MyElemDiagram('slrgex_sf_car');

Version History

Introduced in R2018b

See Also