padv.builtin.task.GenerateSDDReport Class
Namespace: padv.builtin.task
Superclasses: padv.Task
Task for generating a System Design Description (SDD) report
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.
Note
If you are using the pipeline generator,
padv.pipeline.generatePipeline
, this task is not supported for the
parallel pipeline architecture IndependentModelPipelines
.
Creation
Description
creates a task for generating a System Design Description (SDD) report using Simulink
Report Generator.task
= padv.builtin.task.GenerateSDDReport()
sets certain properties using one or more name-value arguments. For example, task
= padv.builtin.task.GenerateSDDReport(Name=Value
)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
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 PropertiesName
— Unique identifier for task in process
"padv.builtin.task.GenerateSDDReport"
(default) | string
Unique identifier for task in process, specified as a string.
Example: "MyGenerateSDDReportTask"
Data Types: string
Title
— Human-readable name that appears in Process Advisor app
"Generate SDD Report"
(default) | string
Human-readable name that appears in Process Advisor app, specified as a string.
Example: "My Generate SDD Report Task"
Data Types: string
DescriptionText
— Task description
"This task uses Simulink Report Generator to create a
System Design Description report for your models."
(default) | 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
DescriptionCSH
— Path to task documentation
path to GenerateSDDReport
documentation (default) | 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
RequiredIterationArtifactType
— Artifact type that task can run on
"sl_model_file"
(default) | ...
Type of artifact, specified as one or more of the values listed in this table. To specify multiple values, use an array.
Category | Artifact Type | Description |
---|---|---|
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 | |
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) |
| 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 | |
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"]
IterationQuery
— Find artifacts that task iterates over
padv.builtin.query.FindModels
(default) | padv.Query
object | name of padv.Query
object
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.
InputDependencyQuery
— Finds artifact dependencies for task inputs
padv.Query
object | name of padv.Query
object
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
Licenses
— List of licenses that task requires
["matlab_report_gen"
"simulink_report_gen"]
(default) | string
List of licenses that the task requires, specified as a string.
Data Types: string
LaunchToolAction
— Function that launches tool
@launchToolAction
(default) | function handle
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
LaunchToolText
— Description of action that LaunchToolAction
property performs
"Open SDD Report Options"
(default) | string
Description of the action that the LaunchToolAction
property
performs, specified as a string.
Data Types: string
InputQueries
— Inputs to task
padv.Query
object | name of padv.Query
object | array of padv.Query
objects
Inputs to the task, specified as:
a
padv.Query
objectthe name of
padv.Query
objectan array of
padv.Query
objectsan 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
.
OutputDirectory
— Location for standard task outputs
fullfile('$DEFAULTOUTPUTDIR$', '$ITERATIONARTIFACT$',
'system_design_description')
(default) | string
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
DisplayReport
— Open generated report
false
or 0
(default) | true
or 1
Open the generated report, specified as a numeric or logical 1
(true
) or 0
(false
).
Example: true
Data Types: logical
IncludeCustomLibraries
— Include custom libraries in design description
false
or 0
(default) | true
or 1
Include custom libraries in the design description, specified as a numeric or
logical 1
(true
) or 0
(false
).
Example: true
Data Types: logical
IncludeDetails
— Include design details in design description
true
or 1
(default) | false
or 0
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
IncludeGlossary
— Include glossary in design description
true
or 1
(default) | false
or 0
Include a glossary in the design description, specified as a numeric or logical
1
(true
) or 0
(false
).
Example: false
Data Types: logical
IncludeLookupTables
— Include lookup tables in design description
true
or 1
(default) | false
or 0
Include lookup tables in the design description, specified as a numeric or logical
1
(true
) or 0
(false
).
Example: false
Data Types: logical
IncludeModelRefs
— Include model references in design description
false
or 0
(default) | true
or 1
Include model references in the design description, specified as a numeric or
logical 1
(true
) or 0
(false
).
Example: true
Data Types: logical
IncludeRequirementsLinks
— Include requirement links in design description
true
or 1
(default) | false
or 0
Include requirement links in the design description, specified as a numeric or
logical 1
(true
) or 0
(false
).
Example: false
Data Types: logical
LegalNotice
— Legal notice that appears on report
"For Internal Distribution Only"
(default) | string
Legal notice that appears on the report, specified as a string.
Example: "Confidential"
Data Types: string
ReportFormat
— Output format for generated report
"html"
(default) | "pdf"
| "docx"
Output format for the generated report, specified as either:
"html"
— HTML format. You can use the propertyPackageType
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"
ReportName
— File name for generated report
"$ITERATIONARTIFACT$_SDD"
(default) | string
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
ReportPath
— Path to generated report
fullfile('$DEFAULTOUTPUTDIR$', '$ITERATIONARTIFACT$',
'system_design_description')
(default) | 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
ReportTitle
— Title of report
""
(default) | string
Title of the report, specified as a string.
Data Types: string
TitleImgPath
— Path of image that appears on report title page
""
(default) | string
Path of image that appears on report title page, specified as a string.
Data Types: string
Subtitle
— Subtitle of report
"Design Description"
(default) | string
Subtitle of the report, specified as a string.
Data Types: string
TimeFormat
— Date and time format for report creation date
""
(default) | "dd-mmm-yyyy"
| "HH:MM:SS"
Since R2024b
Date and time format for report creation date, specified as one of the values listed in this table.
Value | Example Output |
---|---|
"dd-mmm-yyyy HH:MM:SS" | 26-Jul-2021 17:10:21 |
"dd-mmm-yyyy" | 26-Jul-2021 |
"mm/dd/yy" | 07/26/21 |
"mmm" | Jul |
"m" | J |
"mm" | 07 |
"mm/dd" | 07/26 |
"dd" | 26 |
"ddd" | Mon |
"d" | M |
"yyyy" | 2021 |
"yy" | 21 |
"mmmyy" | Jul21 |
"HH:MM:SS" | 17:10:21 |
"HH:MM:SS PM" | 5:10:21 PM |
"HH:MM" | 17:10 |
"HH:MM PM" | 5:10 PM |
"QQ-YY" | Q3-21 |
"QQ" | Q3 |
By default, if you do not specify a value for TimeFormat
, the
SDD report uses "dd-mmm-yyyy HH:MM:SS"
. The date and time appear next
to Published on the title page of the report.
Example: "dd-mmm-yyyy"
Data Types: string
UseStatusWindow
— Display report generation status messages in separate window
false
or 0
(default) | true
or 1
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
Specialized Public Methods
This class overrides the following inherited methods.
run | Generate a System Design Description (SDD) report using Simulink Report Generator Note You do not need to manually invoke this method. When you run a task using
the Process
Advisor app or the
The function taskResult = run(obj, input) ... end |
dryRun |
Dry run the task to validate task inputs and generate
representative task outputs without actually running the task. The function taskResult = dryRun(obj, input) ... end |
launchToolAction | Launch Report Options dialog. Process Advisor uses this method when you open the tool associated with a task. |
Examples
Add SDD Report Generation Task to Process
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";
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)