slreportgen.report.Notes Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

Simulink or Stateflow diagram notes reporter

Description

Create a reporter that reports on Simulink^® or Stateflow^® diagram notes. See Write In-Model Documentation Using Notes for more information on model notes.

Note

To use a Notes reporter in a report, you must create the report using the slreportgen.report.Report class.

The slreportgen.report.Notes class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

notes = slreportgen.report.Notes creates an empty slreportgen.report.Notes reporter.

notes = slreportgen.report.Notes(source) creates an slreportgen.report.Notes reporter for the system specified by source and sets the Source property to source.

slreportgen.report.Notes(Name=Value) sets the reporter properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

Source — Source from which to extract notes

[] (default) | string scalar | character vector | handle | slreportgen.finder.DiagramResult object

Source from which to extract notes, specified as a string scalar, character vector, handle, or slreportgen.finder.DiagramResult object. The source can be a model, subsystem, Stateflow chart, Stateflow truth table, or Stateflow state transition table.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

NoteType — Type of notes

"None" (default) | "Internal" | "External | "Inherit"

Type of notes, specified as one of the values in this table:

Value	Description
"Internal"	Note content is included with the model and is saved in a .mldatx file.
"External"	Note content is external to the model and is specified by a URL.
"Inherited"	Note content originates from the ancestors of the specified diagram source.
"None"	The diagram does not have notes.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ReportOnInheritNoteType — Whether to report on notes with type inherit

false (default) | true

Whether to report on notes that have a NoteType of "Inherit", specified as true or false. The reported note content is based on the parent note NoteType property.

Value	Description
"Internal"	Link to parent note content.
"External"	Link to external content specified by the parent note.
"None"	Empty content.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

exportToHTML	htmlContent = exportToHTML(notes) exports the internal notes associated with the specified slreportgen.report.Notes reporter to a string of HTML. If the NoteType of the note reporter is not "Internal", the exportToHTML method ends with an error.
exportToHTMLFile	fullFileName = exportToHTMLFile(notes,filename) exports the internal notes associated with the specified slreportgen.report.Notes reporter to the specified HTML file. If the NoteType of the note reporter is not "Internal" or if the HTML file name exists, the exportToHTMLFile method ends with an error.
getURL	getURL(notes) returns the URL of the external notes associated with the specified slreportgen.report.Notes reporter as a string. If the NoteType of the note reporter is not "External", the getURL method ends with an error.
slreportgen.report.Notes.createTemplate	Copy the default slreportgen.report.Notes reporter template.
slreportgen.report.Notes.customizeReporter	Subclass the slreportgen.report.Notes class for customization.
copy	Create copy of a Simulink reporter object and make deep copies of certain property values
slreportgen.report.Notes.getClassFolder	Get the location of the folder that contains the slreportgen.report.Notes reporter class definition file.
getImpl	Get implementation of reporter

Examples

Include Model Notes in a Report

This example reports the notes for the sldemo_autotrans model. This example reports the notes for the overall model. For an example that reports the diagram and notes for each subsystem of the model, see Report Model Notes.

The example creates a chapter for the notes and includes the model notes in the chapter by adding an slreportgen.report.Notes reporter to the chapter.

model = "sldemo_autotrans";
open_system(model);

import mlreportgen.report.*
import slreportgen.report.*

rpt = slreportgen.report.Report(model + "_Notes_Report","pdf");
open(rpt);

ch = Chapter(Title=(model+" Notes"));
notes = Notes(model);
add(ch,notes);
add(rpt,ch);

close(rpt);
rptview(rpt);

Tips

• Use slreportgen.utils.hasUniqueModelNotes to check if a source has model notes before using the source with an slreportgen.report.Notes reporter.

Version History

Introduced in R2020a