The PromoteStatistic() function allows you to copy a specified statistic value from the test to the overview report. These copied statistics appear in the "Statistic Results" section of the overview report between the design specifications and the spreadsheet-compatible results. This function also allows you to rename the statistics.
In this topic:
The PromoteStatistic() function has two versions:
| Argument | Range | Description |
| statistic_name | n/a | An ASCII string value only with no spaces or other non-alphanumeric characters. |
| overview_statistic_name | n/a | A string value that may contain spaces and other non-alphanumeric characters.* |
* The spaces and non-alphanumeric characters in the overview_statistic_name helps to clarify what the statistic value represents on the overview report since an auto-generated statistic name is often not as descriptive as it could be.
A statistic value exists with the name "NOM(VOUT)" and a value of 1.223. The following calls in the testplan will promote the statistic value to the overview report.
PromoteStatistic() also exists as a SIMetrix script function and can be called from a post-process or final-process script. The arguments for this function when called from a script are slightly different than the testplan version. The script function syntax is as follows:
SimplisDVMAdvancedUtilMeasurementPromoteStatistic(array, log_file)
where array is a SIMetrix string array with two or three elements:
The examples above could be generated in a PostProcess script with the following calls:
| Let return = SimplisDVMAdvancedUtilMeasurementPromoteStatistic([ 'AVG(VOUT)', '1.223' ], log_file) |
| Let return = SimplisDVMAdvancedUtilMeasurementPromoteStatistic([ 'AVG(VOUT)', '1.223', 'Average Output Voltage (V)' ], log_file) |
The script function return value may be safely ignored.