slreportgen.report.CCaller Class

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

C Caller block reporter

Since R2022a

Description

Use objects of the slreportgen.report.CCaller class to report on C Caller blocks in your Simulink^® model.

By default, a CCaller reporter object reports:

• The name of the C function called by the C Caller block

• The Description parameter and any custom mask parameters

• The port properties associated with the C Caller block

• The C code that the C Caller block invokes

Use the CCaller reporter properties to exclude or modify the reported information.

Note

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

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

cCallerReporter = slreportgen.report.CCaller creates an empty C Caller block reporter with default property values. Use the object properties to specify report options.

Note

Adding an empty CCaller object to a report causes an error.

cCallerReporter = slreportgen.report.CCaller(Object) creates a reporter for the given C Caller block object and sets the Object property to Object.

Include this reporter in your report to add information about the C Caller block name, available functions, and port specifications. Update the properties of the object to change the display options for the reporter.

cCallerReporter = slreportgen.report.CCaller(Name=Value) sets properties by using name-value arguments. Specify multiple name-value arguments in any order.

Properties

Object — C Caller block to report

C Caller block handle | string scalar | character vector | slreportgen.report.BlockResult object

C Caller block to report, specified as a character vector or string scalar that contains the name of a C Caller block, a C Caller block handle, or a slreportgen.report.BlockResult object.

Attributes:

GetAccess	public
SetAccess	public

IncludeObjectProperties — Include block property table

1 (true) (default) | 0 (false)

Include a table of block properties in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a table of block properties in the report.

• 0 (false) — Omit a table of block properties from the report.

This table displays all block dialog parameters except the function name, available functions, and port specifications. If all other dialog parameters are empty, the table is not displayed.

To format this table and the included properties, edit the ObjectPropertiesReporter property.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeAvailableFunctions — Include block functions table

0 (false) (default) | 1 (true)

Include a list of other available functions in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a list of other available functions in the report.

• 0 (false) — Omit a list of other available functions from the report.

This list displays the functions that the C Caller block can call.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeCode — Whether to include C Caller block code

1 (true) (default) | 0 (false)

Whether to include the C code of the C Caller block in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include the C code of the C Caller block in the report.

• 0 (false) — Omit the C code of the C Caller block from the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ObjectPropertiesReporter — Properties for block properties table

slreportgen.report.SimulinkObjectProperties object

Properties for the block properties table, specified as an slreportgen.report.SimulinkObjectProperties object. The default value for this is an empty slreportgen.report.SimulinkObjectProperties object. Specify the properties to display in the Properties property of the SimulinkObjectProperties object. If Properties is empty, the reporter automatically determines which properties to display.

Attributes:

GetAccess	public
SetAccess	public

PortSpecificationsReporter — Format for port properties

mlreportgen.report.BaseTable object

Format the port properties of the C Caller block to report, specified as an mlreportgen.report.BaseTable object. The default value for this property is an empty mlreportgen.report.BaseTable object with the StyleName property set to "CCallerPortSpecificationTable". Customize the appearance of the table by modifying the properties of the default BaseTable object.

Attributes:

GetAccess	public
SetAccess	public

FunctionNameTitleReporter — Paragraph format for function name title

mlreportgen.dom.Paragraph object

Paragraph format for the function name title, specified as an mlreportgen.dom.Paragraph object. The default value is an empty mlreportgen.dom.Paragraph object with StyleName set to "CCallerFunctionNameTitle".

Customize the appearance of the title by modifying the properties of the default object or by replacing it with another Paragraph object.

Attributes:

GetAccess	public
SetAccess	public

FunctionNameReporter — Paragraph format for function name

mlreportgen.dom.Paragraph object

Paragraph format for the function name, specified as an mlreportgen.dom.Paragraph object. The default value is an empty mlreportgen.dom.Paragraph object with StyleName set to "CCallerFunctionName".

Customize the appearance of the function name by modifying the properties of the default object or by replacing it with another Paragraph object.

Attributes:

GetAccess	public
SetAccess	public

AvailableFunctionsTitleFormatter — Paragraph format for available functions titles

mlreportgen.dom.Paragraph object

Paragraph format for the title of the available functions list, specified as an mlreportgen.dom.Paragraph object. The default value is an empty mlreportgen.dom.Paragraph object with StyleName set to "CCallerAvailableFunctionsTitle".

Customize the appearance of the title by modifying the properties of the default object or by replacing it with another Paragraph object.

Attributes:

GetAccess	public
SetAccess	public

AvailableFunctionsListFormatter — Format for list of available functions

mlreportgen.dom.UnorderedList object (default) | mlreportgen.dom.OrderedList object

List of available functions, specified as an mlreportgen.dom.UnorderedList or mlreportgen.dom.OrderedList object.

The default value is a mlreportgen.dom.UnorderedList object. Customize the appearance of the list by modifying the properties of the default object or by replacing it with another object that does not contain any children.

Attributes:

GetAccess	public
SetAccess	public

CodeTitleFormatter — Paragraph format for code section title

mlreportgen.dom.Paragraph object

Paragraph format for the title of the C code for the C Caller block, specified as an mlreportgen.dom.Paragraph object. The default value is an empty mlreportgen.dom.Paragraph object with the property StyleName set to "CCallerCodeTitle".

Customize the appearance of the title by modifying the properties of the default object or by replacing it with another Paragraph object. Any content added to the Paragraph object in this property appears before the code title in the report.

Attributes:

GetAccess	public
SetAccess	public

CodeFormatter — Format for included C code

mlreportgen.dom.Preformatted object

Format the C code included in your reporter, specified as an mlreportgen.dom.Preformatted object.

The default value for this property is an empty mlreportgen.dom.Preformatted object with StyleName property set to "CCallerCode". Customize the appearance of the code by modifying the properties of the default object.

Attributes:

GetAccess	public
SetAccess	public

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
Dependent	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

Method	Purpose
slreportgen.report.CCaller.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.CCaller.customizeReporter	Create reporter from slreportgen.report.CCaller class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.CCaller at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.CCaller.getClassFolder	Get location of folder that contains slreportgen.report.CCaller class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Add C Caller Block Reporter to Report

This example shows how to add information about C Caller blocks in your Simulink® model to a report.

Create a PDF report and load the required model.

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

rpt = slreportgen.report.Report("CCallerReport","pdf");
rpt.CompileModelBeforeReporting = false;
model_name = 'ExampleModelSLR';
load_system(model_name);

% Create a chapter for the C Caller block information
add(rpt,TitlePage(...
    Title=sprintf('C Caller Blocks in %s', model_name),Author=""));
add(rpt, TableOfContents);

Create a SystemDiagramFinder object to return the diagrams for each C Caller block in the model.

diagFinder = SystemDiagramFinder(model_name);

Iterate through the results of the finder object and find the associated C Caller blocks.

while hasNext(diagFinder)
    diagram = next(diagFinder);
    chapter = Chapter(...
        Title=mlreportgen.utils.normalizeString(diagram.Name));
    add(chapter, diagram);

    finder = BlockFinder(diagram.Object);
    finder.BlockTypes = "CCaller";
    results = find(finder);
    
    for result = results 
        rptr = CCaller(result);     
        rptr.IncludeAvailableFunctions = true;
        add(chapter,rptr);
    end
    add(rpt, chapter);
end
close(rpt);
close_system(model_name);
rptview(rpt);

Version History

Introduced in R2022a