| ||||||||||||||||||||||||||||||||||||||||||||
rsReportConfigCreate a report configuration. SyntaxRsReportConfig *rsReportConfig ( RsReportItem items, RsCoverageMetric summaryMetrics, RsCoverageMetric detailMetrics, RsTargetStatus detailStatus ); Parameters
Return ValuePointer to a Report configuration, which will produce a report containing the specified information.
The returned configuration should be discarded via a call to
rsReportConfigClose once it is no longer needed. Note that functions
which generate reports make their own copy of the configuration, so
deleting the configuration will not affect any report data which has
already been generated.
rsReportConfigDefaultCreates a report configuration with default settings. SyntaxRsReportConfig *rsReportConfigDefault (void); ParametersNone. Return ValuePointer to a report configuration which will produce a report containing default information, which includes everything except MCC coverage data. The configuration can be changed using the rsReportConfigSet functions. Note that rsReportConfigDefault () is equivalent to rsReportConfig (RsRptDefault, RsCvgDefault, RsCvgDefault, RsTgtDefault).
The returned configuration should be closed via a call to
rsReportConfigClose once it is no longer needed. Note that functions
which generate reports make their own copy of the configuration, so
deleting the configuration will not affect any report data which has
already been generated.
rsReportConfigCloseClose a report configuration. Stop using a report configuration. Syntaxvoid rsReportConfigClose (RsReportConfig *config); Parameters
Return Value
None. The memory which holds the value of config is recycled. Any
subsequent use of the configuration is erroneous, any will have
unpredictable effects. Note that functions which generate reports make a
copy of the configuration, so it is safe to delete the configuration
immediately after they are used.
rsReportConfigGetGlobalDefaultGet the global default report configuration. SyntaxRsReportConfig *rsReportConfigGetGlobalDefault (RsHandle *h); Parameters
Return ValuePointer to a report configuration whose settings match the values shown in the "Default Model-Specific Settings" dialog. NULL is returned if an error occurred while retrieving the report configuration, in which case you may call rsGetLastError to retrieve the error message. The returned configuration should be closed via a call to
rsReportConfigClose once it is no longer needed. Note that functions
which generate reports make their own copy of the configuration, so
deleting the configuration will not affect any report data which has
already been generated.
rsReportConfigGetItemsGet items included in report configuration. Get the set of items which will appear in a report. SyntaxRsReportItem rsReportConfigGetItems (const RsReportConfig *config); Parameters
Return Value
The set of items (in the form of an RsReportItem bit-mask) which will
appear in any report generated from config.
rsReportConfigGetSummaryMetricsGet summary metrics in report configuration. Get the set of metrics which will appear in the Coverage Summary section of a report. SyntaxRsCoverageMetric rsReportConfigGetSummaryMetrics (const RsReportConfig *config); Parameters
Return Value
The set of items (in the form of an RsCoverageMetric bit-mask) which will
appear in the Coverage Summary section of any report generated from
config.
rsReportConfigGetDetailMetricsGet detail metrics in report configuration. Get the set of metrics which will appear in the Coverage Details section of a report. SyntaxRsCoverageMetric rsReportConfigGetDetailMetrics (const RsReportConfig *config); Parameters
Return Value
The set of coverage metrics (in the form of an RsCoverageMetric bit-mask)
which will appear in the Coverage Details section of any report
generated via config.
rsReportConfigGetDetailStatusGet detail status in report configuration. Get the set of coverage statuses which will appear in the Coverage Details section of a report. SyntaxRsTargetStatus rsReportConfigGetDetailStatus (const RsReportConfig *config); Parameters
Return Value
The set of target coverage statuses (in the form of an RsTargetStatus
bit-mask) which will appear in the Coverage Details section of any
report generated from config.
rsReportConfigGetDiffLimitGet the limit on the number of difference details which will appear in a report. Syntaxunsigned int rsReportConfigGetDiffLimit(const RsReportConfig*); Parameters
Return ValueA limit on the number of differences for which details will appear in a
report. Differences beyond the limit are still counted in summaries, but
no details are given.
rsReportConfigSetGlobalDefaultSet the global default report configuration. Syntaxint rsReportConfigSetGlobalDefault( RsHandle *h, const RsReportConfig* config ); Parameters
Return Value
rsReportConfigSetItemsSet items included in report configuration. Specify which items will appear in a report. Syntaxvoid rsReportConfigSetItems ( const RsReportConfig *config, RsReportItem items ); Parameters
Return Value
None. The set of items which will appear in any report generated from
config is set to items.
rsReportConfigSetSummaryMetricsSet summary metrics in report configuration. Specify which metrics will appear in the Coverage Summary section of a report. Syntaxvoid rsReportConfigSetSummaryMetrics ( const RsReportConfig *config, RsCoverageMetric metrics ); Parameters
Return Value
None. The set of items which will appear in the Coverage Summary
section of any report generated from config is set to
metrics.
rsReportConfigSetDetailMetricsSet detail metrics in report configuration. Specify which metrics will appear in the Coverage Details section of a report. Syntaxvoid rsReportConfigSetDetailMetrics ( const RsReportConfig *config, RsCoverageMetric metrics ); Parameters
Return Value
None. The set of coverage metrics which will appear in the Coverage
Details section of any report generated from config is set to
metrics.
rsReportConfigSetDetailStatusSet detail status in report configuration. Specify which coverage statuses will appear in the Coverage Details section of a report. Syntaxvoid rsReportConfigSetDetailStatus ( const RsReportConfig *config, RsTargetStatus status ); Parameters
Return Value
None. The set of target coverage statuses which will appear in the
Coverage Details section of any report generated from
config is set to status.
rsReportConfigSetDiffLimitSpecify a limit on the number of difference details which will appear in a report. Syntaxvoid rsReportConfigSetDiffLimit( RsReportConfig*, unsigned int limit ); Parameters
Effectsconfig is updated so that the difference details are limited to
the specified quantity in any report generated from config.
Differences beyond this limit will still be counted in summaries, but no
details will be given.
rsReportItemFromStringConverts a string to an individual RsReportItem value. SyntaxRsReportItem rsReportItemFromString (const char *str); Parameters
Return ValueReturns the individual RsReportItem value whose name matches str (using case-insensitive comparison). The RsReportItem values are listed in RsReportItem.
Returns RsRptNone if there is no match. In this case, rsGetLastError
should NOT be called.
rsReportItemToStringConverts an individual RsReportItem value to a string. Syntaxconst char *rsReportItemToString (RsReportItem item); Parameters
Return ValueReturns a constant string representing item, one of the individual report items. The strings that report items mapped to are listed in RsReportItem.
Returns NULL if item is not one of the individual RsReportItem
values. In this case, rsGetLastError should NOT be called.
rsRsiGetDefaultReportConfigGet the default report configuration for an .rsi file. SyntaxRsReportConfig *rsRsiGetDefaultReportConfig (RsRsiFile *hRsi); Parameters
Return ValuePointer to a report configuration whose settings match the values shown in the "Default Model-Specific Settings" dialog. NULL is returned if an error occurred while retrieving the report configuration, in which case you may call rsGetLastError to retrieve the error message. The returned configuration should be closed via a call to
rsReportConfigClose once it is no longer needed. Note that functions
which generate reports make their own copy of the configuration, so
deleting the configuration will not affect any report data which has
already been generated.
rsRsiSetDefaultReportConfigSet the default report configuration for an .rsi file. Syntaxint rsRsiSetDefaultReportConfig( RsRsiFile *hRsi, const RsReportConfig* config ); Parameters
Return Value
rsTargetStatusFromStringConvert a string to a RsTargetStatus value. SyntaxRsTargetStatus rsTargetStatusToString (const char *str); Parameters
Return ValueReturns the target status whose value matches str (using case-insensitive comparison). The target status values are listed in RsTargetStatus.
Returns RsTgtNone if there is no match. In this case, rsGetLastError
should NOT be called.
rsTargetStatusToStringConvert a RsTargetStatus value to a string. Syntaxconst char *rsTargetStatusToString (RsTargetStatus stat); Parameters
Return ValueReturns a constant string representing the value of stat, if stat is one of the individual status values listed in RsTargetStatus. The value of this string will be one of the names listed in RsTargetStatus.
Returns NULL if stat is not one of the individual target status
values. In this case, rsGetLastError should NOT be called.
| ||||||||||||||||||||||||||||||||||||||||||||