|
Reactis for C API V2019
API - Reactis for C: MATLAB Bindings - Reactis Report Configuration
rcReportConfig
Create a report configuration.
Syntax
cfgId = rcReportConfig()
cfgId = rcReportConfig(items, summaryMetrics, detailMetrics, detailStatus)
Description
cfgId = rcReportConfig() creates a report configuration
using all default settings.
cfgId = rcReportConfig(items, summaryMetrics, detailMetrics, detailStatus) creates a report configuration using the given settings.
- items
- Is a cell array of strings containing any combination of the
following items:
- ExportDate
- Include current date
- FilePaths
- Include full paths for all files
- TableOfContents
- Include a table of contents
- Summary
- Include a coverage summary
- Coverage
- Include coverage details
- FunctionCalls
- Include function call count for C functions
- All
- Include all of the above
- Default
- Include all of the above
- summaryMetrics
- Specifies a list of coverage metrics to be included in the summary
section of the report.
- detailMetrics
- Specifies a list of coverage metrics to be
included in the detail section of the report. Note that metrics included in
the detail section will automatically be included in the summary section.
- summaryMetrics and detailMetrics
- Are cell arrays of strings
containing any combination of the following metrics:
CStatement, Decision, Condition, MCDC, MCC, Boundary,
UserTarget, Assertion, CFunction, CFunctionCall
or the special names All (includes all metrics) or
Default (includes all but MCC).
- detailStatus
- Is a cell array of strings containing any combination of the following
items:
- Covered
- Include covered targets in the "details" section
- Uncovered
- Include uncovered targets in the "details" section
- Unreachable
- Include unreachable targets in the "details" section,/dd>
- All
- Include all of the above
- Default
- Include all of the above
cfgId is a scalar integer valued double that identifies the report configuration when calling other rcReport* API functions.
Examples
rptid = rcReportConfig('Default', ...
{'Condition', 'Decision', 'Branch'}, ...
{'Condition', 'Decision', 'Branch'}, ...
'Default');
See Also
rcSimRunSuite, rcTester, rcTesterStart, rcReportConfigClose,
rcReportConfigGetItems, rcReportConfigSetItems,
rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics
rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics,
rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus
rcReportConfigClose
Close a report configuration.
Syntax
rcReportConfigClose(cfgId)
Description
rcReportConfigClose(cfgId) closes the report configuration
identified by cfgId and releases any memory allocated with it.
See Also
rcReportConfig
rcReportConfigSetItems
Set items included in coverage report configuration.
Syntax
rcReportConfigSetItems(cfgId, items)
Description
rcReportConfigSetItems(cfgId, items) sets items to include
in coverage report to items. items is a cell array of
strings containing any combination of the following:
ExportDate | Include current date |
FilePaths | Include full paths for all files |
TableOfContents | Include a table of contents |
Summary | Include a coverage summary |
Coverage | Include coverage details |
FunctionCalls | Include function call count for C functions |
All | Include all of the above |
Default | Include all of the above |
See Also
rcReportConfig, rcReportConfigClose, rcReportConfigGetItems,
rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics,
rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics,
rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus
rcReportConfigSetSummaryMetrics
Set summary metrics included in coverage report configuration.
Syntax
rcReportConfigSetSummaryMetrics(cfgId, metrics)
Description
rcReportConfigSetSummaryMetrics(cfgId, metrics)
sets metrics to include in the summary of the coverage report to metrics. metrics is a cell array of strings containing any
combination of the following metrics:
CStatement, Decision, Condition, MCDC, MCC, Boundary,
UserTarget, Assertion, CFunction, CFunctionCall
or the special names All (includes all metrics) or
Default (includes all but MCC).
See Also
rcReportConfig, rcReportConfigClose, rcReportConfigGetItems,
rcReportConfigSetItems, rcReportConfigGetSummaryMetrics,
rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics,
rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus
rcReportConfigSetDetailMetrics
Set detail metrics included in coverage report configuration.
Syntax
rcReportConfigSetDetailMetrics(cfgId, metrics)
Description
rcReportConfigSetDetailMetrics(cfgId, metrics) sets metrics
to include in the detail of the coverage report to metrics.
metrics is a cell array of strings containing any combination of the following metrics:
CStatement, Decision, Condition, MCDC, MCC, Boundary, UserTarget,
Assertion, CFunction, CFunctionCall
or the special names All (includes all metrics) or Default (includes all but MCC).
See Also
rcReportConfig, rcReportConfigClose, rcReportConfigGetItems,
rcReportConfigSetItems, rcReportConfigGetSummaryMetrics,
rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics,
rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus
rcReportConfigSetDetailStatus
Set detail metrics included in coverage report configuration.
Syntax
rcReportConfigSetDetailStatus(cfgId, status)
Description
rcReportConfigSetDetailStatus(cfgId, status)
sets status of item to include in the detail section of the coverage report.
status is a cell array of strings containing any combination
of the following items:
Covered | Include covered targets in the details section. |
Uncovered | Include uncovered targets in the details section. |
Unreachable | Include unreachable targets in the details section. |
All | Include all of the above. |
Default | Include all of the above. |
See Also
rcReportConfig, rcReportConfigClose, rcReportConfigGetItems,
rcReportConfigSetItems, rcReportConfigGetSummaryMetrics,
rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics,
rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus
|