Main Content

padv.builtin.task.GenerateSDDReport Class

Namespace: padv.builtin.task
Superclasses: padv.Task

Task for generating a System Design Description (SDD) report

expand all in page

Description

This class requires CI/CD Automation for Simulink Check.

The padv.builtin.task.GenerateSDDReport class provides a task that can generate a System Design Description (SDD) report from a predefined template using Simulink® Report Generator™. The System Design Description report provides a summary or detailed information about a system design represented by a model.

You can add the task to your process model by using the method addTask. After you add the task to your process model, you can run the task from the Process Advisor app or by using the function runprocess.

To view the source code for this built-in task, in the MATLAB® Command Window, enter:

open padv.builtin.task.GenerateSDDReport

The padv.builtin.task.GenerateSDDReport class is a handle class.

Creation

Description

task = padv.builtin.task.GenerateSDDReport() creates a task for generating a System Design Description (SDD) report using Simulink Report Generator.

example

task = padv.builtin.task.GenerateSDDReport(Name=Value) sets certain properties using one or more name-value arguments. For example, task = padv.builtin.task.GenerateSDDReport(Name = "MySDDReportTask") creates a task with the specified name.

You can use this syntax to set property values for InputQueries, Name, IterationQuery, InputDependencyQuery, Licenses, LaunchToolAction, and LaunchToolText.

The padv.builtin.task.GenerateSDDReport class also has other properties, but you cannot set those properties during task creation.

Properties

expand all

The GenerateSDDReport class inherits properties from padv.Task. The properties listed in Specialized Inherited Properties are padv.Task properties that the GenerateSDDReport task overrides.

The task also has properties for specifying SDD Report Options for specifying the report options for an SDD object.

Specialized Inherited Properties

Unique identifier for task in process, specified as a string.

Example: "MyGenerateSDDReportTask"

Data Types: string

Human-readable name that appears in Process Advisor app, specified as a string.

Example: "My Generate SDD Report Task"

Data Types: string

Task description, specified as a string.

When you point to a task in Process Advisor and click the information icon, the tooltip shows the task description.

Example: "This task uses Simulink Report Generator to create a System Design Description report for your models."

Data Types: string

Path to task documentation, specified as a string.

When you point to a task in Process Advisor, click the ellipsis (...), and click Help, Process Advisor opens the task documentation.

Example: fullfile(pwd,"taskHelpFiles","myTaskDocumentation.pdf")

Data Types: string

Type of artifact, specified as one or more of the values listed in this table. To specify multiple values, use an array.

CategoryArtifact TypeDescription

MATLAB

"m_class"MATLAB class
"m_file"MATLAB file
"m_func"MATLAB function
"m_method"MATLAB class method
"m_property"MATLAB class property

Model Advisor

"ma_config_file"Model Advisor configuration file
"ma_justification_file"Model Advisor justification file

Other

"coder_code_files"Code files
"other_file"Other file

Process Advisor

"padv_dep_artifacts"

Related artifacts that current artifact depends on

"padv_output_file"

Process Advisor output file

Project

"project"Current project file

Requirements

"mwreq_item"Requirement (since R2024b)

"sl_req"

Requirement (for R2024a and earlier)
"sl_req_file"Requirement file
"sl_req_table"Requirements Table

Stateflow®

"sf_chart"Stateflow chart
"sf_graphical_fcn"Stateflow graphical function
"sf_group"Stateflow group
"sf_state"Stateflow state
"sf_state_transition_chart"Stateflow state transition chart
"sf_truth_table"Stateflow truth table

Simulink

"sl_block_diagram"Block diagram
"sl_data_dictionary_file"Data dictionary file
"sl_embedded_matlab_fcn"MATLAB function
"sl_block_diagram"Block diagram
"sl_library_file"Library file
"sl_model_file"Simulink model file
"sl_protected_model_file"Protected Simulink model file
"sl_subsystem"Subsystem
"sl_subsystem_file"Subsystem file
"sl_subsystem"Subsystem

System Composer™

"zc_block_diagram"System Composer architecture
"zc_component"System Composer architecture component
"zc_file"System Composer architecture file
Tests"harness_info_file"Harness info file
"sl_harness_block_diagram"Harness block diagram
"sl_harness_file"Test harness file
"sl_test_case"Simulink Test™ case
"sl_test_case_result"Simulink Test case result
"sl_test_file"Simulink Test file
"sl_test_iteration"Simulink Test iteration
"sl_test_iteration_result"Simulink Test iteration result
"sl_test_report_file"Simulink Test result report
"sl_test_result_file"Simulink Test result file
"sl_test_resultset"Simulink Test result set
"sl_test_seq"Test Sequence
"sl_test_suite"Simulink Test suite
"sl_test_suite_result"Simulink Test suite result

Example: "sl_model_file"

Example: ["sl_model_file "zc_file"]

Query that finds the artifacts that the task iterates over, specified as a padv.Query object or the name of a padv.Query object. When you specify IterationQuery, the task runs one time for each artifact returned by the query. In the Process Advisor app, the artifacts returned by IterationQuery appear under task title.

For more information about task iterations, see Overview of Process Model.

Query that finds artifact dependencies for task inputs, specified as a padv.Query object or the name of a padv.Query object.

The build system runs the query specified by InputDependencyQuery to find the dependencies for the task inputs, since those dependencies can impact if task results are up-to-date.

For more information about task inputs, see Overview of Process Model.

Example: padv.builtin.query.GetDependentArtifacts

List of licenses that the task requires, specified as a string.

Data Types: string

Function that launches a tool, specified as the function handle.

When you point to a task in the Process Advisor app, you can click the ellipsis (...) to see more options. For built-in tasks, you have the option to launch a tool associated with the task.

For the task GenerateSDDReport, you can launch a Report Options dialog.

Data Types: function_handle

Description of the action that the LaunchToolAction property performs, specified as a string.

Data Types: string

Inputs to the task, specified as:

  • a padv.Query object

  • the name of padv.Query object

  • an array of padv.Query objects

  • an array of names of padv.Query objects

By default, the task GenerateSDDReport gets the current model that the task is iterating over by using the built-in query padv.builtin.query.GetIterationArtifact.

Location for standard task outputs, specified as a string.

The built-in tasks use tokens, like $DEFAULTOUTPUTDIR$, as placeholders for dynamic path resolution during run-time. For more information, see Dynamically Resolve Paths with Tokens.

Data Types: string

SDD Report Options

Open the generated report, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

Data Types: logical

Include custom libraries in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

Data Types: logical

Include design details, like block parameters, in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: false

Data Types: logical

Include a glossary in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: false

Data Types: logical

Include lookup tables in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: false

Data Types: logical

Include model references in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

Data Types: logical

Include requirement links in the design description, specified as a numeric or logical 1 (true) or 0 (false).

Example: false

Data Types: logical

Increment the report name to avoid overwriting an existing report, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

Data Types: logical

Legal notice that appears on the report, specified as a string.

Example: "Confidential"

Data Types: string

File packaging type for HTML reports, specified as either:

  • 1 — Zipped. Package report files in a single compressed file that has the report name, with a .zip extension.

  • 2 — Unzipped. Generate the report files in a subfolder of the current folder. The subfolder has the report name.

  • 3 — Both zipped and unzipped. Package the report files as both zipped and unzipped.

Note that this parameter is only enabled when ReportFormat is "html".

Example: 2

Output format for the generated report, specified as either:

  • "html" — HTML format. You can use the property PackageType to specify whether report files are zipped, unzipped, or produce both zipped and unzipped files.

  • "pdf" — PDF format

  • "docx" — Microsoft® Word document format

Example: "pdf"

File name for the generated report, specified as a string.

The built-in tasks use tokens, like $ITERATIONARTIFACT$, as placeholders for dynamic path resolution during run-time. For more information, see Dynamically Resolve Paths with Tokens.

Example: "mySDDReport"

Data Types: string

Path to the generated report, specified as a string.

The built-in tasks use tokens, like $DEFAULTOUTPUTDIR$, as placeholders for dynamic path resolution during run-time. For more information, see Dynamically Resolve Paths with Tokens.

Data Types: string

Title of the report, specified as a string.

Data Types: string

Path of image that appears on report title page, specified as a string.

Data Types: string

Subtitle of the report, specified as a string.

Data Types: string

The SDD report does not use this property.

Display report generation status messages in separate window, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

Data Types: logical

Methods

expand all

Examples

collapse all

Add a task that can generate an SDD report for the models in your project.

Open the process model for your project. If you do not have a process model, open the Process Advisor app to automatically create a process model.

In the process model file, add the GenerateSDDReport task to your process model by calling the addTask method on the padv.ProcessModel object pm.

sddTask = pm.addTask(padv.builtin.task.GenerateSDDReport);

You can reconfigure the task behavior by using the task properties. For example, to generate a PDF instead of HTML, set the task property ReportFormat to "pdf".

sddTask.ReportFormat = "pdf";

See Also

| | |

Topics