1 /*******************************************************************************
2 * Copyright (c) 2014, 2015 École Polytechnique de Montréal and others.
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
10 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.xycharts
.linecharts
;
15 import java
.util
.LinkedHashMap
;
17 import java
.util
.Map
.Entry
;
19 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
20 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
21 import org
.eclipse
.swt
.SWT
;
22 import org
.eclipse
.swt
.graphics
.Point
;
23 import org
.eclipse
.swt
.widgets
.Composite
;
24 import org
.eclipse
.swt
.widgets
.Display
;
25 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalManager
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
27 import org
.eclipse
.tracecompass
.tmf
.ui
.signal
.TmfTimeViewAlignmentInfo
;
28 import org
.eclipse
.tracecompass
.tmf
.ui
.signal
.TmfTimeViewAlignmentSignal
;
29 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.xycharts
.TmfChartTimeStampFormat
;
30 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.xycharts
.TmfXYChartViewer
;
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
;
36 import org
.swtchart
.ISeriesSet
;
37 import org
.swtchart
.LineStyle
;
38 import org
.swtchart
.Range
;
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.
46 * @author - Geneviève Bastien
48 public abstract class TmfCommonXLineChartViewer
extends TmfXYChartViewer
{
50 private static final double DEFAULT_MAXY
= Double
.MIN_VALUE
;
51 private static final double DEFAULT_MINY
= Double
.MAX_VALUE
;
53 /* The desired number of points per pixel */
54 private static final double RESOLUTION
= 1.0;
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
};
63 private final Map
<String
, double[]> fSeriesValues
= new LinkedHashMap
<>();
64 private double[] fXValues
;
65 private double fResolution
;
67 private UpdateThread fUpdateThread
;
73 * The parent composite
75 * The title of the viewer
77 * The label of the xAxis
79 * The label of the yAXIS
81 public TmfCommonXLineChartViewer(Composite parent
, String title
, String xLabel
, String yLabel
) {
82 super(parent
, title
, xLabel
, yLabel
);
83 getSwtChart().getTitle().setVisible(false);
84 getSwtChart().getLegend().setPosition(SWT
.BOTTOM
);
85 getSwtChart().getAxisSet().getXAxes()[0].getTitle().setVisible(false);
86 setResolution(RESOLUTION
);
87 setTooltipProvider(new TmfCommonXLineChartTooltipProvider(this));
91 * Set the number of requests per pixel that should be done on this chart
94 * The number of points per pixels
96 protected void setResolution(double resolution
) {
97 fResolution
= resolution
;
101 public void loadTrace(ITmfTrace trace
) {
102 super.loadTrace(trace
);
107 * Forces a reinitialization of the data sources, even if it has already
108 * been initialized for this trace before
110 protected void reinitialize() {
111 fSeriesValues
.clear();
112 Thread thread
= new Thread() {
113 // Don't use TmfUiRefreshHandler (bug 467751)
116 initializeDataSource();
117 if (!getSwtChart().isDisposed()) {
118 getDisplay().asyncExec(new Runnable() {
121 if (!getSwtChart().isDisposed()) {
122 /* Delete the old series */
135 * Initialize the source of the data for this viewer. This method is run in
136 * a separate thread, so this is where for example one can execute an
137 * analysis module and wait for its completion to initialize the series
139 protected void initializeDataSource() {
143 private class UpdateThread
extends Thread
{
144 private final IProgressMonitor fMonitor
;
145 private final int fNumRequests
;
147 public UpdateThread(int numRequests
) {
148 super("Line chart update"); //$NON-NLS-1$
149 fNumRequests
= numRequests
;
150 fMonitor
= new NullProgressMonitor();
155 Display
.getDefault().syncExec(new Runnable() {
158 updateData(getWindowStartTime(), getWindowEndTime(), fNumRequests
, fMonitor
);
161 updateThreadFinished(this);
164 public void cancel() {
165 fMonitor
.setCanceled(true);
169 private synchronized void newUpdateThread() {
171 if (!getSwtChart().isDisposed()) {
172 final int numRequests
= (int) (getSwtChart().getPlotArea().getBounds().width
* fResolution
);
173 fUpdateThread
= new UpdateThread(numRequests
);
174 fUpdateThread
.start();
178 private synchronized void updateThreadFinished(UpdateThread thread
) {
179 if (thread
== fUpdateThread
) {
180 fUpdateThread
= null;
185 * Cancels the currently running update thread. It is automatically called
186 * when the content is updated, but child viewers may want to call it
187 * manually to do some operations before calling
188 * {@link TmfCommonXLineChartViewer#updateContent}
190 protected synchronized void cancelUpdate() {
191 if (fUpdateThread
!= null) {
192 fUpdateThread
.cancel();
197 protected void updateContent() {
198 getDisplay().asyncExec(new Runnable() {
207 * Convenience method to compute the values of the X axis for a given time
208 * range. This method will return at most nb values, equally separated from
209 * start to end. The step between values will be at least 1.0, so the number
210 * of values returned can be lower than nb.
212 * The returned time values are in internal time, ie to get trace time, the
213 * time offset needs to be added to those values.
216 * The start time of the time range
218 * End time of the range
220 * The maximum number of steps in the x axis.
221 * @return The time values (converted to double) to match every step.
223 protected static final double[] getXAxis(long start
, long end
, int nb
) {
224 long steps
= (end
- start
);
227 nbVals
= (int) steps
;
232 double step
= steps
/ (double) nbVals
;
234 double timestamps
[] = new double[nbVals
];
236 for (int i
= 0; i
< nbVals
; i
++) {
237 timestamps
[i
] = curTime
;
244 * Set the values of the x axis. There is only one array of values for the x
245 * axis for all series of a line chart so it needs to be set once here.
248 * The values for the x axis. The values must be in internal
249 * time, ie time offset have been subtracted from trace time
252 protected final void setXAxis(double[] xaxis
) {
257 * Update the series data because the time range has changed. The x axis
258 * values for this data update can be computed using the
259 * {@link TmfCommonXLineChartViewer#getXAxis(long, long, int)} method which
260 * will return a list of uniformely separated time values.
262 * Each series values should be set by calling the
263 * {@link TmfCommonXLineChartViewer#setSeries(String, double[])}.
265 * This method is responsible for calling the
266 * {@link TmfCommonXLineChartViewer#updateDisplay()} when needed for the new
267 * values to be displayed.
270 * The start time of the range for which the get the data
272 * The end time of the range
274 * The number of 'points' in the chart.
276 * The progress monitor object
278 protected abstract void updateData(long start
, long end
, int nb
, IProgressMonitor monitor
);
281 * Set the data for a given series of the graph. The series does not need to
282 * be created before calling this, but it needs to have at least as many
283 * values as the x axis.
285 * If the series does not exist, it will automatically be created at display
286 * time, with the default values.
289 * The name of the series for which to set the values
290 * @param seriesValues
291 * The array of values for the series
293 protected void setSeries(String seriesName
, double[] seriesValues
) {
294 if (fXValues
.length
> seriesValues
.length
) {
295 throw new IllegalStateException();
297 fSeriesValues
.put(seriesName
, seriesValues
);
301 * Add a new series to the XY line chart. By default, it is a simple solid
305 * The name of the series to create
306 * @return The series so that the concrete viewer can modify its properties
309 protected ILineSeries
addSeries(String seriesName
) {
310 ISeriesSet seriesSet
= getSwtChart().getSeriesSet();
311 int seriesCount
= seriesSet
.getSeries().length
;
312 ILineSeries series
= (ILineSeries
) seriesSet
.createSeries(SeriesType
.LINE
, seriesName
);
313 series
.setVisible(true);
314 series
.enableArea(false);
315 series
.setLineStyle(LINE_STYLES
[(seriesCount
/ (LINE_COLORS
.length
)) % LINE_STYLES
.length
]);
316 series
.setSymbolType(PlotSymbolType
.NONE
);
317 series
.setLineColor(Display
.getDefault().getSystemColor(LINE_COLORS
[seriesCount
% LINE_COLORS
.length
]));
322 * Delete a series from the chart and its values from the viewer.
325 * Name of the series to delete
327 protected void deleteSeries(String seriesName
) {
328 ISeries series
= getSwtChart().getSeriesSet().getSeries(seriesName
);
329 if (series
!= null) {
330 getSwtChart().getSeriesSet().deleteSeries(series
.getId());
332 fSeriesValues
.remove(seriesName
);
336 * Update the chart's values before refreshing the viewer
338 protected void updateDisplay() {
339 Display
.getDefault().asyncExec(new Runnable() {
340 final TmfChartTimeStampFormat tmfChartTimeStampFormat
= new TmfChartTimeStampFormat(getTimeOffset());
344 if (!getSwtChart().isDisposed()) {
345 double[] xValues
= fXValues
;
346 if (xValues
.length
< 1) {
349 double maxy
= DEFAULT_MAXY
;
350 double miny
= DEFAULT_MINY
;
351 for (Entry
<String
, double[]> entry
: fSeriesValues
.entrySet()) {
352 ILineSeries series
= (ILineSeries
) getSwtChart().getSeriesSet().getSeries(entry
.getKey());
353 if (series
== null) {
354 series
= addSeries(entry
.getKey());
356 series
.setXSeries(xValues
);
357 /* Find the minimal and maximum values in this series */
358 for (double value
: entry
.getValue()) {
359 maxy
= Math
.max(maxy
, value
);
360 miny
= Math
.min(miny
, value
);
362 series
.setYSeries(entry
.getValue());
364 if (maxy
== DEFAULT_MAXY
) {
368 IAxisTick xTick
= getSwtChart().getAxisSet().getXAxis(0).getTick();
369 xTick
.setFormat(tmfChartTimeStampFormat
);
371 final double start
= xValues
[0];
372 int lastX
= xValues
.length
- 1;
373 double end
= (start
== xValues
[lastX
]) ? start
+ 1 : xValues
[lastX
];
374 getSwtChart().getAxisSet().getXAxis(0).setRange(new Range(start
, end
));
376 getSwtChart().getAxisSet().getYAxis(0).setRange(new Range(miny
, maxy
));
378 getSwtChart().redraw();
380 if (isSendTimeAlignSignals()) {
381 // The width of the chart might have changed and its
382 // time axis might be misaligned with the other views
383 Point viewPos
= TmfCommonXLineChartViewer
.this.getParent().getParent().toDisplay(0, 0);
384 int axisPos
= getSwtChart().toDisplay(0, 0).x
+ getPointAreaOffset();
385 int timeAxisOffset
= axisPos
- viewPos
.x
;
386 TmfTimeViewAlignmentInfo timeAlignmentInfo
= new TmfTimeViewAlignmentInfo(getControl().getShell(), viewPos
, timeAxisOffset
);
387 TmfSignalManager
.dispatchSignal(new TmfTimeViewAlignmentSignal(TmfCommonXLineChartViewer
.this, timeAlignmentInfo
, true));
395 * Create the series once the initialization of the viewer's data source is
396 * done. Series do not need to be created before setting their values, but
397 * if their appearance needs to be customized, this method is a good place
398 * to do so. It is called only once per trace.
400 protected void createSeries() {
405 protected void clearContent() {
406 getSwtChart().getAxisSet().getXAxis(0).getTick().setFormat(null);
407 super.clearContent();