| |
Reactis API V2022.2
API - Reactis (MATLAB Bindings):
|
| rsReportConfig | Create a report configuration. |
| rsReportConfigClose | Close a report configuration. |
| rsReportConfigGetGlobalDefault | Create a report configuration using global default values. |
| rsReportConfigGetItems | Get items included in report configuration. |
| rsReportConfigGetSummaryMetrics | Get summary metrics in report configuration. |
| rsReportConfigGetDetailMetrics | Get detail metrics in report configuration. |
| rsReportConfigGetDetailStatus | Get detail status in report configuration. |
| rsReportConfigGetDiffLimit | Get the limit on the number of difference details which will appear in a report. |
| rsReportConfigSetGlobalDefault | Save a report configuration as the global default. |
| rsReportConfigSetItems | Set items included in report configuration. |
| rsReportConfigSetSummaryMetrics | Set summary metrics in report configuration. |
| rsReportConfigSetDetailMetrics | Set detail metrics in report configuration. |
| rsReportConfigSetDetailStatus | Set detail status in report configuration. |
| rsReportConfigSetDiffLimit | Set the limit on the number of difference details included in coverage report configuration. |
| rsRsiGetDefaultReportConfig | Get the default report configuration from an .rsi file. |
| rsRsiSetDefaultReportConfig | Save a report configuration as the default for an .rsi file. |
rsReportConfig
Create a report configuration.
Syntax
cfgId = rsReportConfig() cfgId = rsReportConfig(items, summaryMetrics, detailMetrics, detailStatus)
Description
cfgId = rsReportConfig() creates a report configuration
using all default settings.
cfgId = rsReportConfig(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 summary statistics for each test: test number, test name, number of steps, errors, warnings, differences. |
| Coverage | Include coverage information. |
| FunctionCalls | Include function call count for C functions. |
| ExcludedTargets | Include a list of excluded coverage targets. |
| SimParameters | Include a list of simulation control parameters. |
| InputPlots | Include plots of inputs for all tests. |
| OutputDiffPlots | Include plots of outputs for tests with differences. |
| OutputNoDiffPlots | Include plots of outputs for tests without any differences. |
| TestPointDiffPlots | Input plots of test points for tests with differences. |
| TestPointNoDiffPlots | Include plots of test points for tests without any differences. |
| StepToCoveredTargetMap | Include a table listing the targets that were covered on each test step. |
| StoreTestsInSeparateFiles | Create a separate HTML file for each test. |
| All | Include all of the above. |
| Default | Include ExportDate, FilePaths, TableOfContents, Summary, Coverage, FunctionCalls, ExcludedTargets and SimParameters. |
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: Subsystem, Branch, State, ConditionAction, TransitionAction, CSEPT, Decision, Condition, MCDC, MCC, Boundary, Lookup UserTarget, Assertion, CStatement, EmlStatement 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. |
| Uncovered | Include uncovered targets. |
| Unreachable | Include unreachable targets. |
| 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 rsReport* API functions.
Examples
rptid = rsReportConfig('Default', ...
{'Condition', 'Decision', 'Branch'}, ...
{'Condition', 'Decision', 'Branch'}, ...
'Default');
See Also
rsSimRunSuite, rsTester, rsTesterStart, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigClose
Close a report configuration.
Syntax
rsReportConfigClose(cfgId)
Description
rsReportConfigClose(cfgId) closes the report configuration
identified by cfgId and releases any memory allocated with it.
See Also
rsReportConfigrsReportConfigGetGlobalDefault
Create a report configuration using global default values.
Syntax
cfgId = rsReportConfigGetGlobalDefault
Description
cfgId = rsReportConfigGetGlobalDefault creates a report
configuration using global default settings, which is identified by
cfgId.
See Also
rsReportConfig, rsReportConfigSetGlobalDefault, rsReportConfigClosersReportConfigGetItems
Get items included in report configuration.
Syntax
items = rsReportConfigGetItems(cfgId)
Description
items = rsReportConfigGetItems(cfgId) returns a cell array
of strings listing all items included in coverage report configuration
cfgId. The possible items are:
| ExportDate | Include current date. |
| FilePaths | Include full paths for all files. |
| TableOfContents | Include a table of contents. |
| Summary | Include summary statistics for each test: test number, test name, number of steps, errors, warnings, differences. |
| Coverage | Include coverage information. |
| FunctionCalls | Include function call count for C functions. |
| ExcludedTargets | Include a list of excluded coverage targets. |
| SimParameters | Include a list of simulation control parameters. |
| InputPlots | Include plots of inputs for all tests. |
| OutputDiffPlots | Include plots of outputs for tests with differences. |
| OutputNoDiffPlots | Include plots of outputs for tests without any differences. |
| TestPointDiffPlots | Input plots of test points for tests with differences. |
| TestPointNoDiffPlots | Include plots of test points for tests without any differences. |
| StepToCoveredTargetMap | Include a table listing the targets that were covered on each test step. |
| StoreTestsInSeparateFiles | Create a separate HTML file for each test. |
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigGetSummaryMetrics
Get summary metrics in report configuration.
Syntax
summaryMetrics = rsReportConfigGetSummaryMetrics(cfgId)
Description
summaryMetrics = rsReportConfigGetSummaryMetrics(cfgId)
returns a cell array of strings (Coverage Metric Names) listing
the summary metrics included in report configuration cfgId.
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigGetDetailMetrics
Get detail metrics in report configuration.
Syntax
detailMetrics = rsReportConfigGetDetailMetrics(cfgId)
Description
detailMetrics = rsReportConfigGetDetailMetrics(cfgId)
returns a cell array of strings (Coverage Metric Names) listing
the detail metrics included in report configuration cfgId.
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigGetDetailStatus
Get detail status in report configuration.
Syntax
detailStatus = rsReportConfigGetDetailStatus(cfgId)
Description
detailStatus = rsReportConfigGetDetailStatus(cfgId)
returns a cell array of strings describing the coverage status
items to be included for each coverage target in the Coverage
Details section of the report configuration. Each coverage
status item string is one of the following:
| Covered | Include covered targets. |
| Uncovered | Include uncovered targets. |
| Unreachable | Include unreachable targets. |
| All | Include all of the above. |
| Default | Include all of the above. |
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigSetDetailStatusrsReportConfigGetDiffLimit
Get the limit on the number of difference details which will appear in a report.
Syntax
limit = rsReportConfigGetDiffLimit(cfgId)
Description
limit = rsReportConfigGetDiffLimit(cfgId) sets
limit to the limit on the number of differences which will appear
in a report generated using the configuration identified by cfgId.
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigSetDiffLimit, rsReportConfigGetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigSetDetailStatus, rsReportConfigGetDetailStatusrsReportConfigSetGlobalDefault
Save a report configuration as the global default.
Syntax
rsReportConfigSetGlobalDefault(cfgId)
Description
rsReportConfigGetGlobalDefault(cfgId) saves the report
configuration identified by cfgId as the new global default.
See Also
rsReportConfig, rsReportConfigGetGlobalDefaultrsReportConfigSetItems
Set items included in report configuration.
Syntax
rsReportConfigSetItems(cfgId, items)
Description
rsReportConfigSetItems(cfgId, items) sets items to include
in report configuration to items, 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 summary statistics for each test: test number, test name, number of steps, errors, warnings, differences. |
| Coverage | Include coverage information. |
| FunctionCalls | Include function call count for C functions. |
| ExcludedTargets | Include a list of excluded coverage targets. |
| SimParameters | Include a list of simulation control parameters. |
| InputPlots | Include plots of inputs for all tests. |
| OutputDiffPlots | Include plots of outputs for tests with differences. |
| OutputNoDiffPlots | Include plots of outputs for tests without any differences. |
| TestPointDiffPlots | Input plots of test points for tests with differences. |
| TestPointNoDiffPlots | Include plots of test points for tests without any differences. |
| StepToCoveredTargetMap | Include a table listing the targets that were covered on each test step. |
| StoreTestsInSeparateFiles | Create a separate HTML file for each test. |
| All | Include all of the above. |
| Default | Include ExportDate, FilePaths, TableOfContents, Summary, Coverage, FunctionCalls, ExcludedTargets and SimParameters. |
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigSetSummaryMetrics
Set summary metrics in report configuration.
Syntax
rsReportConfigSetSummaryMetrics(cfgId, summaryMetrics)
Description
rsReportConfigSetSummaryMetrics(cfgId, summaryMetrics)
sets metrics to include in the summary of the report configuration
to summaryMetrics, a cell array of strings containing any
combination of Coverage Metric Names,
All (includes all metrics), or
Default (includes all metrics except MCC).
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigSetDetailMetrics
Set detail metrics in report configuration.
Syntax
rsReportConfigSetDetailMetrics(cfgId, detailMetrics)
Description
rsReportConfigSetDetailMetrics(cfgId, detailMetrics) set
the list of metrics for which detailed coverage information will be
reported to detailMetrics, a cell array of strings containing any
combination of Coverage Metric Names, All (includes all
metrics), or Default (includes all metrics except MCC).
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsReportConfigSetDetailStatus
Set detail status in report configuration.
Syntax
rsReportConfigSetDetailStatus(cfgId, detailStatus)
Description
rsReportConfigSetDetailStatus(cfgId, detailStatus)
sets the coverage status items to be included for each coverage target
in the Coverage Details section of the report configuration to
detailStatus, a cell array of strings containing any combination
of the following:
| Covered | Include covered targets. |
| Uncovered | Include uncovered targets. |
| Unreachable | Include unreachable targets. |
| All | Include all of the above. |
| Default | Include all of the above. |
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetItems, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigSetDetailStatusrsReportConfigSetDiffLimit
Set the limit on the number of difference details included in coverage report configuration.
Syntax
rsReportConfigGetItems(cfgId, n)
Description
rsReportConfigGetItems(cfgId, n) sets the limit of the
number of difference details in reports generated using the report
configuration identified by cfgId to n.
See Also
rsReportConfig, rsReportConfigClose, rsReportConfigGetDiffLimit, rsReportConfigSetItems, rsReportConfigGetSummaryMetrics, rsReportConfigSetSummaryMetrics, rsReportConfigGetDetailMetrics, rsReportConfigSetDetailMetrics, rsReportConfigGetDetailStatus, rsReportConfigSetDetailStatusrsRsiGetDefaultReportConfig
Get the default report configuration from an .rsi file.
Syntax
cfgId = rsReportConfigGetGlobalDefault(rsiId)
Description
cfgId = rsReportConfigGetGlobalDefault(rsiId) retrieves the
default report configuration from the .rsi file identified by
rsiId. cfgId is the identifier for the retrieved report
configuration.
See Also
rsRsiOpen, rsReportConfig, rsRsiSetDefaultReportConfigrsRsiSetDefaultReportConfig
Save a report configuration as the default for an .rsi file.
Syntax
rsReportConfigGetGlobalDefault(rsiId, cfgId)
Description
rsReportConfigGetGlobalDefault(rsiId, cfgId) saves the
report configuration identified by cfgId as the new default for
the .rsi file identified by rsiId.