Reactis Report Configuration

10. Reactis Report Configuration#

10.1. rcReportConfig#

Create a report configuration.

10.1.1. Syntax#

cfgId = rcReportConfig()
cfgId = rcReportConfig(items, summaryMetrics, detailMetrics, detailStatus)

10.1.2. 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 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.
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: 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.
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.

10.1.3. Examples#

rptid = rcReportConfig('Default', ...
                       {'Condition', 'Decision', 'Branch'}, ...
                       {'Condition', 'Decision', 'Branch'}, ...
                       'Default');

10.1.4. See Also#

rcSimRunSuite, rcTester, rcTesterStart, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigSetItems, rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.2. rcReportConfigClose#

Close a report configuration.

10.2.1. Syntax#

rcReportConfigClose(cfgId)

10.2.2. Description#

rcReportConfigClose(cfgId): closes the report configuration identified by cfgId and releases any memory allocated with it.

10.2.3. See Also#

rcReportConfig

10.3. rcReportConfigGetItems#

Get items included in coverage report configuration.

10.3.1. Syntax#

items = rcReportConfigGetItems(cfgId)

10.3.2. Description#

items = rcReportConfigGetItems(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.
StepToCoveredTargetMap	Include a table listing the targets that were covered on each test step.
StoreTestsInSeparateFiles	Create a separate HTML file for each test.

10.3.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigSetItems, rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.4. rcReportConfigGetSummaryMetrics#

Get summary metrics included in coverage report configuration.

10.4.1. Syntax#

metrics = rcReportConfigGetSummaryMetrics(cfgId)

10.4.2. Description#

metrics = rcReportConfigGetSummaryMetrics(cfgId): returns a cell array of strings listing the summary metrics included in coverage report configuration cfgId.

10.4.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigSetItems, rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.5. rcReportConfigGetDetailMetrics#

Get detail metrics included in coverage report configuration.

10.5.1. Syntax#

metrics = rcReportConfigGetDetailMetrics(cfgId)

10.5.2. Description#

metrics = rcReportConfigGetDetailMetrics(cfgId): returns a cell array of strings listing the detail metrics included in coverage report configuration cfgId.

10.5.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigSetItems, rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.6. rcReportConfigGetDetailStatus#

Get detail status included in coverage report configuration.

10.6.1. Syntax#

status = rcReportConfigGetDetailStatus(cfgId)

10.6.2. Description#

status = rcReportConfigGetDetailStatus(cfgId): returns a cell array of strings showing items of which status (Covered/Uncovered/Unreachable) will be included in the details section of the coverage report.

10.6.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigSetItems, rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigSetDetailStatus

10.7. rcReportConfigSetItems#

Set items included in coverage report configuration.

10.7.1. Syntax#

rcReportConfigSetItems(cfgId, items)

10.7.2. 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 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.
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.

10.7.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigGetSummaryMetrics, rcReportConfigSetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.8. rcReportConfigSetSummaryMetrics#

Set summary metrics included in coverage report configuration.

10.8.1. Syntax#

rcReportConfigSetSummaryMetrics(cfgId, metrics)

10.8.2. 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).

10.8.3. See Also#

rcReportConfig, rcReportConfigClose, rcReportConfigGetItems, rcReportConfigSetItems, rcReportConfigGetSummaryMetrics, rcReportConfigGetDetailMetrics, rcReportConfigSetDetailMetrics, rcReportConfigGetDetailStatus, rcReportConfigSetDetailStatus

10.9. rcReportConfigSetDetailMetrics#

Set detail metrics included in coverage report configuration.

10.9.1. Syntax#

rcReportConfigSetDetailMetrics(cfgId, metrics)

10.9.2. 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: