The PromoteGraph() function places a copy of the specified graph on the overview report. You can add any number of graphs, define their order, and rename the graphs on the overview report.
In this topic:
To implement this functionality, the PromoteGraph() function has four versions with one required argument and three optional arguments that provide flexibility.
PromoteGraph(DVM Bode Plot#ac#log, 100)
Using one of the alternate forms allows you to promote graphs by the short name:
PromoteGraph(DVM Bode Plot, 100, 1)
Finally, a graph can be renamed on the overview report using the fourth function definition. This example renames the graph to DVM Bode Plot (Max Vin).
PromoteGraph(DVM Bode Plot, 110, 1, DVM Bode Plot (Max Vin) )
The weighting system uses a numeric sorting routine to determine the display order of the overview graphs. The ordering of the overview graphs are as follows, starting at the top of the report:
If, in any of these categories, more than one graph exists with the same weight, the graphs with identical weight are alphabetically sorted by graph name.
PromoteGraph() 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 function name and arguments are:
SimplisDVMAdvancedUtilMeasurementPromoteGraph(array, log_file)
The Bode Plot examples above could be generated in a post-process script with the following script function calls:
Let return = SimplisDVMAdvancedUtilMeasurementPromoteGraph([ 'DVM Bode Plot#ac#log', '100' ], log_file) |
Let return = SimplisDVMAdvancedUtilMeasurementPromoteGraph([ 'DVM Bode Plot', '100', '1' ], log_file) |
Let return = SimplisDVMAdvancedUtilMeasurementPromoteGraph([ 'DVM Bode Plot', '110', '1', 'DVM Bode Plot (Max Vin)' ], log_file) |
The script function return value may be safely ignored.