slreportgen.report.SimulinkObjectProperties.customizeReporter

Class: slreportgen.report.SimulinkObjectProperties
Namespace: slreportgen.report

Create custom Simulink object properties class

Syntax

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

Description

reporter = slreportgen.report.SimulinkObjectProperties.customizeReporter(classpath) creates a Simulink^® object properties page class definition file that is a subclass of slreportgen.report.SimulinkObjectProperties. The file is created at the specified classpath location. The SimulinkObjectProperties.customizeReporter method also copies the default Simulink object properties templates to the <classpath>/resources/template folder. To design a custom Simulink object properties class for your report, use the new class definition file as a starting point.

Input Arguments

expand all

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

Value	Description
`slreportgen.report.SimulinkObjectProperties.customizeReporter("myFolder/MyClass")`	Create `MyClass.m` in the subfolder `myFolder` of the current folder.
`slreportgen.report.SimulinkObjectProperties.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.SimulinkObjectProperties.customizeReporter("+myOrg/@MyClass")`	Create the reporter class in a class namespace by preceding the folder name with the `+` character.

slreportgen.report.SimulinkObjectProperties.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.SimulinkObjectProperties.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

`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.

Simulink object properties

Examples

Create Custom Simulink Object Properties Reporter

Create a custom Simulink object properties 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 MySFObjProps.m class file is <current working folder>/newSFObjProps/@MySFObjProps/MySFObjProps.m. The default title page templates are in the <current working folder>/newTitlePage/@MySFObjProps/resources/templates folder.

import slreportgen.report.*
StateflowObjectProperties.customizeReporter...
     ('newSFObjProps/@MySFObjProps');

After editing this new class file, you can use it as your Simulink object properties reporter.

objprop = MySFObjProps();

Version History

Introduced in R2017b