API - Reactis (C Bindings):
Reactis Info File (Coverage)

rsRsiGetCoverageEnabled

Get enabled/disabled status of a coverage metric.

Get the enabled/disabled status of a coverage objective. The names of coverage objectives can be retrieved via the rsGetCoverageCriteriaName API function. Metric names are listed in Coverage Metric Names.

Syntax

int rsRsiGetCoverageEnabled (RsiFile  *h, const char *name);

Parameters

h

Pointer to RsiFile structure as returned by rsRsiOpen.

name

Name of the coverage objective.

Return Value

1

If coverage objective is enabled.

0

If coverage objective is disabled.

-1

If an error occurred. In this case, you may call rsGetLastError to retrieve the error message string.

rsRsiSetCoverageEnabled

Set enabled/disabled status of a coverage metric.

Set the enabled/disabled status of a coverage objective. The names of coverage objectives can be retrieved via the rsGetCoverageCriteriaName API function. Currently valid coverage objective names are listed above for the rsRsiGetCoverageEnabled API function.

Syntax

int rsRsiSetCoverageEnabled (RsiFile  *h, const char *name, int enable);

Parameters

h

Pointer to RsiFile structure as returned by rsRsiOpen.

name

Name of the coverage objective.

enable

If 0, coverage tracking for the objective will be disabled, otherwise it will be enabled.

Return Value

0

If an error occurred. In this case, call rsGetLastError to get the error string.

1

If no error occurred.

rsRsiGetSystemCoverageTracking

Get coverage tracking status of a subsystem.

Query the coverage tracking status for a specified subsystem.

Syntax

int rsRsiGetSystemCoverageTracking (
    RsiFile  *h,
    char *sys
);

Parameters

h

Pointer to an RsiFile structure as returned by rsRsiOpen.

sys

System for which to query the coverage tracking status. Specified as a path beginning with the model name and separating subsystem names with “/”. For example: cruise/CruiseMain/CruiseMDL

Return Value

-1

If an error occurred. In that case, call rsGetLastError to retrieve the error message string.

0

If coverage is set to “disabled”.

1

If coverage is set to “enabled”.

2

If coverage is set to “inherited”.

rsRsiSetSystemCoverageTracking

Set coverage tracking status of a subsystem.

Set the coverage tracking status for a specified subsystem.

Syntax

int rsRsiSetSystemCoverageTracking (RsiFile  *h,     char *sys
int enable);

Parameters

h

Pointer to RsiFile structure as returned by rsRsiOpen.

sys

System for which to set the coverage tracking status. Specified as a path beginning with the model name and separating subsystem names with “/”. For example: cruise/CruiseMain/CruiseMDL

enable

New coverage tracking status:

Value	Meaning
0	Disabled
1	Enabled
2	Inherited

Return Value

0

If an error occurred. In this case, call rsGetLastError to get the error string.

1

If no error occurred.

rsRsiSetCumulativeCoverage

Enable/Disable cumulative coverage tracking.

Enable/Disable cumulative coverage tracking for a library system or referenced model.

Syntax

int rsRsiSetCumulativeCoverage(RsRsiFile *hRsi,
     const char *sys,
     int enable
);

Parameters

hRsi

Pointer to RsRsiFile structure as returned by rsRsiOpen.

sys

System for which to query the coverage setting. Specified as a path beginning with the model name and separating subsystem names with "/". Note that this is the path of the referenced systems.

enable: 1

To enable cumulative coverage tracking.

enable: 0

To disable cumulative coverage tracking.

Return Value

0

If an error occurred. In this case call rsGetLastError to get the error string.

1

If no error occurred.

rsRsiIsCumulativeCoverage

Query cumulative coverage tracking status for a system.

Syntax

int rsRsiIsCumulativeCoverage(RsRsiFile *hRsi, const char *sys)

Parameters

hRsi

Pointer to RsRsiFile structure as returned by rsRsiOpen.

sys

System for which to query the coverage setting. Specified as a path beginning with the model name and separating subsystem names with "/". Note that this is the path of the referenced systems.

Return Value

0

If cumulative coverage tracking is disabled.

1

If cumulative coverage tracking is enabled.

-1

If an error occurred. In this case you may call rsGetLastError to retrieve the error message string.

rsRsiGetNumCumulativeCoverage

Get number of systems for which cumulative coverage tracking is enabled.

Syntax

int rsRsiGetNumCumulativeCoverage(RsRsiFile *hRsi);

Parameters

hRsi

Pointer to RsRsiFile structure as returned by rsRsiOpen.

Return Value

Returns the number of systems for which cumulative coverage tracking is enabled.

rsRsiGetCumulativeCoverage

Return the path of a cumulatively tracked subsystem.

Return the path of a cumulatively tracked subsystem in the .rsi file.

Syntax

int rsRsiGetCumulativeCoverage(RsRsiFile *hRsi,
     int index,
     char *buffer,
     int bufferSize
);

Parameters

hRsi

Pointer to RsRsiFile structure as returned by rsRsiOpen.

index

Index of the system. This value must be greater or equal to 0 and less than the return value of rsRsiGetNumCumulativeCoverage.

buffer

The buffer that receives the system path. The buffer's size must correspond to the value of the bufferSize parameter. If the buffer parameter is NULL then the value returned by rsRsiGetCumulativeCovearge will be the buffer size required to store the whole system path.

bufferSize

The size of the buffer passed in as the third argument. If the actual system path is longer than this value, it will be truncated to the length of the buffer. In that case the return value of rsRsiGetCumulativeCovearge will be the buffer size that would be required to receive the whole system path.

Return Value

-1

If an error occurred. In this case you may call rsGetLastError to retrieve the error message string.

0

On success.

A value greater than 0

If either the buffer parameter is NULL or the bufferSize was not sufficient to receive the complete system path. In that case the value returned specifies the buffer size required to store the complete system path.