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