Ets_An_Panel_Trace_Add()
Note: Requires OPNET Development Kit
Abstract
Adds a trace to an analysis panel.
Syntax
Ets_An_Panel_Trace_Add (an_panel_handle, ordinate_label, abscissa_label, draw_style, array_size, time_array, value_array)
| Argument | Type | Description |
|---|---|---|
an_panel_handle |
EtsT_An_Panel_Handle |
the handle to the panel |
ordinate_label |
const char * |
the y-axis label |
abscissa_label |
const char * |
the x-axis label |
draw_style |
EtsT_An_Trace_Draw_Style |
draw style for the trace (one of the values in Table 10 Analysis Panel Sub-Package Symbolic Constants) |
array_size |
int |
the size of both time_array and value_array |
time_array |
const double * |
the x values for each data point |
value_array |
const double * |
the y values for each data point |
Return Type
EtsT_An_Trace_Handle
the handle to the newly added trace
Header
ets_api_an_panel.h
Details
This function adds a trace to the specified panel. If the display mode of the panel is “stacked”, a new graph will be created on the panel for the trace. If the display mode is “overlaid”, the trace will be added to the only graph on the panel.
This function will create array_size data points in the trace. Each data point will have an (x,y) value pair. The x value for the Nth data point will be the Nth value in time_array. The y value for the Nth data point will be the Nth value in value_array. Note that time_array and value_array must both be at least array_size big.
If the draw style is bar, bar chart, or sample-hold, value_array must end with the constant ETSC_AN_PANEL_UNDEF. The final y value is undefined because the matching x value is used only to determine the width of the final bar or hold-time. If value_array does not end with ETSC_AN_PANEL_UNDEF, this function will treat all data pairs in time_array,value_array as valid data points and try to create a suitable final x value (as well as generating a diagnostic message that the x value was created).