Commit | Line | Data |
---|---|---|
2e427755 GB |
1 | /******************************************************************************* |
2 | * Copyright (c) 2014 École Polytechnique de Montréal | |
3 | * | |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Geneviève Bastien - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.ui.viewers.xycharts.linecharts; |
2e427755 GB |
14 | |
15 | import java.util.LinkedHashMap; | |
16 | import java.util.Map; | |
17 | import java.util.Map.Entry; | |
18 | ||
00968516 GB |
19 | import org.eclipse.core.runtime.IProgressMonitor; |
20 | import org.eclipse.core.runtime.NullProgressMonitor; | |
c85a741e | 21 | import org.eclipse.swt.SWT; |
2e427755 GB |
22 | import org.eclipse.swt.widgets.Composite; |
23 | import org.eclipse.swt.widgets.Display; | |
2bdf0193 AM |
24 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
25 | import org.eclipse.tracecompass.tmf.ui.TmfUiRefreshHandler; | |
26 | import org.eclipse.tracecompass.tmf.ui.viewers.xycharts.TmfChartTimeStampFormat; | |
27 | import org.eclipse.tracecompass.tmf.ui.viewers.xycharts.TmfXYChartViewer; | |
2e427755 GB |
28 | import org.swtchart.IAxisTick; |
29 | import org.swtchart.ILineSeries; | |
30 | import org.swtchart.ILineSeries.PlotSymbolType; | |
31 | import org.swtchart.ISeries; | |
32 | import org.swtchart.ISeries.SeriesType; | |
c85a741e | 33 | import org.swtchart.ISeriesSet; |
2e427755 GB |
34 | import org.swtchart.LineStyle; |
35 | import org.swtchart.Range; | |
36 | ||
37 | /** | |
38 | * Abstract line chart viewer class implementation. All series in this viewer | |
39 | * use the same X axis values. They are automatically created as values are | |
40 | * provided for a key. Series by default will be displayed as a line. Each | |
41 | * series appearance can be overridden when creating it. | |
42 | * | |
43 | * @author - Geneviève Bastien | |
2e427755 GB |
44 | */ |
45 | public abstract class TmfCommonXLineChartViewer extends TmfXYChartViewer { | |
46 | ||
47 | private static final double DEFAULT_MAXY = Double.MIN_VALUE; | |
48 | private static final double DEFAULT_MINY = Double.MAX_VALUE; | |
49 | ||
50 | /* The desired number of points per pixel */ | |
51 | private static final double RESOLUTION = 1.0; | |
52 | ||
c85a741e GB |
53 | private static final int[] LINE_COLORS = { SWT.COLOR_BLUE, SWT.COLOR_RED, SWT.COLOR_GREEN, |
54 | SWT.COLOR_MAGENTA, SWT.COLOR_CYAN, | |
55 | SWT.COLOR_DARK_BLUE, SWT.COLOR_DARK_RED, SWT.COLOR_DARK_GREEN, | |
56 | SWT.COLOR_DARK_MAGENTA, SWT.COLOR_DARK_CYAN, SWT.COLOR_DARK_YELLOW, | |
57 | SWT.COLOR_BLACK, SWT.COLOR_GRAY }; | |
58 | private static final LineStyle[] LINE_STYLES = { LineStyle.SOLID, LineStyle.DASH, LineStyle.DOT, LineStyle.DASHDOT }; | |
59 | ||
2e427755 GB |
60 | private final Map<String, double[]> fSeriesValues = new LinkedHashMap<>(); |
61 | private double[] fXValues; | |
9392459a | 62 | private double fResolution; |
2e427755 | 63 | |
00968516 GB |
64 | private UpdateThread fUpdateThread; |
65 | ||
2e427755 GB |
66 | /** |
67 | * Constructor | |
68 | * | |
69 | * @param parent | |
70 | * The parent composite | |
71 | * @param title | |
72 | * The title of the viewer | |
73 | * @param xLabel | |
74 | * The label of the xAxis | |
75 | * @param yLabel | |
76 | * The label of the yAXIS | |
77 | */ | |
78 | public TmfCommonXLineChartViewer(Composite parent, String title, String xLabel, String yLabel) { | |
79 | super(parent, title, xLabel, yLabel); | |
80 | ||
9392459a | 81 | setResolution(RESOLUTION); |
2e427755 GB |
82 | setTooltipProvider(new TmfCommonXLineChartTooltipProvider(this)); |
83 | } | |
84 | ||
9392459a GB |
85 | /** |
86 | * Set the number of requests per pixel that should be done on this chart | |
87 | * | |
88 | * @param resolution | |
89 | * The number of points per pixels | |
90 | */ | |
91 | protected void setResolution(double resolution) { | |
92 | fResolution = resolution; | |
93 | } | |
94 | ||
2e427755 GB |
95 | @Override |
96 | public void loadTrace(ITmfTrace trace) { | |
97 | super.loadTrace(trace); | |
47cb22a7 GB |
98 | reinitialize(); |
99 | } | |
100 | ||
101 | /** | |
102 | * Forces a reinitialization of the data sources, even if it has already | |
103 | * been initialized for this trace before | |
47cb22a7 GB |
104 | */ |
105 | protected void reinitialize() { | |
2e427755 GB |
106 | fSeriesValues.clear(); |
107 | Thread thread = new Thread() { | |
108 | @Override | |
109 | public void run() { | |
110 | initializeDataSource(); | |
aa9b2552 AM |
111 | TmfUiRefreshHandler.getInstance().queueUpdate(TmfCommonXLineChartViewer.this, |
112 | new Runnable() { | |
2e427755 GB |
113 | @Override |
114 | public void run() { | |
115 | if (!getSwtChart().isDisposed()) { | |
116 | /* Delete the old series */ | |
117 | clearContent(); | |
118 | createSeries(); | |
119 | } | |
120 | } | |
121 | }); | |
122 | } | |
123 | }; | |
124 | thread.start(); | |
125 | } | |
126 | ||
127 | /** | |
128 | * Initialize the source of the data for this viewer. This method is run in | |
129 | * a separate thread, so this is where for example one can execute an | |
130 | * analysis module and wait for its completion to initialize the series | |
131 | */ | |
132 | protected void initializeDataSource() { | |
133 | ||
134 | } | |
135 | ||
00968516 GB |
136 | private class UpdateThread extends Thread { |
137 | private final IProgressMonitor fMonitor; | |
138 | private final int fNumRequests; | |
139 | ||
140 | public UpdateThread(int numRequests) { | |
141 | super("Line chart update"); //$NON-NLS-1$ | |
142 | fNumRequests = numRequests; | |
143 | fMonitor = new NullProgressMonitor(); | |
144 | } | |
145 | ||
146 | @Override | |
147 | public void run() { | |
148 | updateData(getWindowStartTime(), getWindowEndTime(), fNumRequests, fMonitor); | |
149 | updateThreadFinished(this); | |
150 | } | |
151 | ||
152 | public void cancel() { | |
153 | fMonitor.setCanceled(true); | |
154 | } | |
155 | } | |
156 | ||
157 | private synchronized void newUpdateThread() { | |
158 | cancelUpdate(); | |
159 | final int numRequests = (int) (getSwtChart().getPlotArea().getBounds().width * fResolution); | |
160 | fUpdateThread = new UpdateThread(numRequests); | |
161 | fUpdateThread.start(); | |
162 | } | |
163 | ||
164 | private synchronized void updateThreadFinished(UpdateThread thread) { | |
165 | if (thread == fUpdateThread) { | |
166 | fUpdateThread = null; | |
167 | } | |
168 | } | |
169 | ||
170 | /** | |
171 | * Cancels the currently running update thread. It is automatically called | |
172 | * when the content is updated, but child viewers may want to call it | |
173 | * manually to do some operations before calling | |
174 | * {@link TmfCommonXLineChartViewer#updateContent} | |
175 | */ | |
176 | protected synchronized void cancelUpdate() { | |
177 | if (fUpdateThread != null) { | |
178 | fUpdateThread.cancel(); | |
179 | } | |
180 | } | |
181 | ||
2e427755 GB |
182 | @Override |
183 | protected void updateContent() { | |
184 | getDisplay().asyncExec(new Runnable() { | |
2e427755 GB |
185 | @Override |
186 | public void run() { | |
00968516 | 187 | newUpdateThread(); |
2e427755 GB |
188 | } |
189 | }); | |
190 | } | |
191 | ||
192 | /** | |
193 | * Convenience method to compute the values of the X axis for a given time | |
194 | * range. This method will return nb values depending, equally separated | |
195 | * from start to end. | |
196 | * | |
197 | * The returned time values are in internal time, ie to get trace time, the | |
198 | * time offset needs to be added to those values. | |
199 | * | |
200 | * @param start | |
201 | * The start time of the time range | |
202 | * @param end | |
203 | * End time of the range | |
204 | * @param nb | |
205 | * The number of steps in the x axis. | |
206 | * @return The time values (converted to double) to match every step. | |
207 | */ | |
208 | protected final double[] getXAxis(long start, long end, int nb) { | |
209 | setTimeOffset(start - 1); | |
210 | ||
211 | double timestamps[] = new double[nb]; | |
212 | long steps = (end - start); | |
213 | double step = steps / (double) nb; | |
214 | ||
215 | double curTime = 1; | |
216 | for (int i = 0; i < nb; i++) { | |
217 | timestamps[i] = curTime; | |
218 | curTime += step; | |
219 | } | |
220 | return timestamps; | |
221 | } | |
222 | ||
223 | /** | |
224 | * Set the values of the x axis. There is only one array of values for the x | |
225 | * axis for all series of a line chart so it needs to be set once here. | |
226 | * | |
227 | * @param xaxis | |
228 | * The values for the x axis. The values must be in internal | |
229 | * time, ie time offset have been subtracted from trace time | |
230 | * values. | |
231 | */ | |
232 | protected final void setXAxis(double[] xaxis) { | |
233 | fXValues = xaxis; | |
234 | } | |
235 | ||
236 | /** | |
237 | * Update the series data because the time range has changed. The x axis | |
238 | * values for this data update can be computed using the | |
c85a741e GB |
239 | * {@link TmfCommonXLineChartViewer#getXAxis(long, long, int)} method which |
240 | * will return a list of uniformely separated time values. | |
2e427755 GB |
241 | * |
242 | * Each series values should be set by calling the | |
243 | * {@link TmfCommonXLineChartViewer#setSeries(String, double[])}. | |
244 | * | |
245 | * This method is responsible for calling the | |
c85a741e GB |
246 | * {@link TmfCommonXLineChartViewer#updateDisplay()} when needed for the new |
247 | * values to be displayed. | |
2e427755 GB |
248 | * |
249 | * @param start | |
250 | * The start time of the range for which the get the data | |
251 | * @param end | |
252 | * The end time of the range | |
253 | * @param nb | |
254 | * The number of 'points' in the chart. | |
00968516 GB |
255 | * @param monitor |
256 | * The progress monitor object | |
2e427755 | 257 | */ |
00968516 | 258 | protected abstract void updateData(long start, long end, int nb, IProgressMonitor monitor); |
2e427755 GB |
259 | |
260 | /** | |
261 | * Set the data for a given series of the graph. The series does not need to | |
262 | * be created before calling this, but it needs to have at least as many | |
263 | * values as the x axis. | |
264 | * | |
265 | * If the series does not exist, it will automatically be created at display | |
266 | * time, with the default values. | |
267 | * | |
268 | * @param seriesName | |
269 | * The name of the series for which to set the values | |
270 | * @param seriesValues | |
271 | * The array of values for the series | |
272 | */ | |
273 | protected void setSeries(String seriesName, double[] seriesValues) { | |
274 | if (fXValues.length > seriesValues.length) { | |
275 | throw new IllegalStateException(); | |
276 | } | |
277 | fSeriesValues.put(seriesName, seriesValues); | |
278 | } | |
279 | ||
280 | /** | |
281 | * Add a new series to the XY line chart. By default, it is a simple solid | |
282 | * line. | |
283 | * | |
2e427755 GB |
284 | * @param seriesName |
285 | * The name of the series to create | |
286 | * @return The series so that the concrete viewer can modify its properties | |
287 | * if required | |
288 | */ | |
289 | protected ILineSeries addSeries(String seriesName) { | |
c85a741e GB |
290 | ISeriesSet seriesSet = getSwtChart().getSeriesSet(); |
291 | int seriesCount = seriesSet.getSeries().length; | |
292 | ILineSeries series = (ILineSeries) seriesSet.createSeries(SeriesType.LINE, seriesName); | |
2e427755 GB |
293 | series.setVisible(true); |
294 | series.enableArea(false); | |
c85a741e | 295 | series.setLineStyle(LINE_STYLES[(seriesCount / (LINE_COLORS.length)) % LINE_STYLES.length]); |
2e427755 | 296 | series.setSymbolType(PlotSymbolType.NONE); |
c85a741e | 297 | series.setLineColor(Display.getDefault().getSystemColor(LINE_COLORS[seriesCount % LINE_COLORS.length])); |
2e427755 GB |
298 | return series; |
299 | } | |
300 | ||
301 | /** | |
302 | * Delete a series from the chart and its values from the viewer. | |
303 | * | |
304 | * @param seriesName | |
305 | * Name of the series to delete | |
306 | */ | |
307 | protected void deleteSeries(String seriesName) { | |
308 | ISeries series = getSwtChart().getSeriesSet().getSeries(seriesName); | |
309 | if (series != null) { | |
310 | getSwtChart().getSeriesSet().deleteSeries(series.getId()); | |
311 | } | |
312 | fSeriesValues.remove(seriesName); | |
313 | } | |
314 | ||
315 | /** | |
316 | * Update the chart's values before refreshing the viewer | |
317 | */ | |
318 | protected void updateDisplay() { | |
319 | Display.getDefault().asyncExec(new Runnable() { | |
320 | final TmfChartTimeStampFormat tmfChartTimeStampFormat = new TmfChartTimeStampFormat(getTimeOffset()); | |
321 | ||
322 | @Override | |
323 | public void run() { | |
324 | if (!getSwtChart().isDisposed()) { | |
325 | double maxy = DEFAULT_MAXY; | |
326 | double miny = DEFAULT_MINY; | |
327 | for (Entry<String, double[]> entry : fSeriesValues.entrySet()) { | |
328 | ILineSeries series = (ILineSeries) getSwtChart().getSeriesSet().getSeries(entry.getKey()); | |
329 | if (series == null) { | |
330 | series = addSeries(entry.getKey()); | |
331 | } | |
332 | series.setXSeries(fXValues); | |
333 | /* Find the minimal and maximum values in this series */ | |
334 | for (double value : entry.getValue()) { | |
335 | maxy = Math.max(maxy, value); | |
336 | miny = Math.min(miny, value); | |
337 | } | |
338 | series.setYSeries(entry.getValue()); | |
339 | } | |
9392459a GB |
340 | if (maxy == DEFAULT_MAXY) { |
341 | maxy = 1.0; | |
342 | } | |
2e427755 GB |
343 | |
344 | IAxisTick xTick = getSwtChart().getAxisSet().getXAxis(0).getTick(); | |
345 | xTick.setFormat(tmfChartTimeStampFormat); | |
346 | ||
347 | final double start = fXValues[0]; | |
348 | int lastX = fXValues.length - 1; | |
349 | double end = (start == fXValues[lastX]) ? start + 1 : fXValues[lastX]; | |
350 | getSwtChart().getAxisSet().getXAxis(0).setRange(new Range(start, end)); | |
351 | getSwtChart().getAxisSet().getXAxis(0).adjustRange(); | |
352 | if (maxy > miny) { | |
353 | getSwtChart().getAxisSet().getYAxis(0).setRange(new Range(miny, maxy)); | |
354 | } | |
355 | getSwtChart().redraw(); | |
356 | } | |
357 | } | |
358 | }); | |
359 | } | |
360 | ||
361 | /** | |
362 | * Create the series once the initialization of the viewer's data source is | |
363 | * done. Series do not need to be created before setting their values, but | |
364 | * if their appearance needs to be customized, this method is a good place | |
365 | * to do so. It is called only once per trace. | |
366 | */ | |
367 | protected void createSeries() { | |
368 | ||
369 | } | |
370 | ||
371 | } |