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
);
84 setResolution(RESOLUTION
);
85 setTooltipProvider(new TmfCommonXLineChartTooltipProvider(this));
89 * Set the number of requests per pixel that should be done on this chart
92 * The number of points per pixels
94 protected void setResolution(double resolution
) {
95 fResolution
= resolution
;
99 public void loadTrace(ITmfTrace trace
) {
100 super.loadTrace(trace
);
105 * Forces a reinitialization of the data sources, even if it has already
106 * been initialized for this trace before
108 protected void reinitialize() {
109 fSeriesValues
.clear();
110 Thread thread
= new Thread() {
113 initializeDataSource();
114 getDisplay().asyncExec(new Runnable() {
117 if (!getSwtChart().isDisposed()) {
118 /* Delete the old series */
130 * Initialize the source of the data for this viewer. This method is run in
131 * a separate thread, so this is where for example one can execute an
132 * analysis module and wait for its completion to initialize the series
134 protected void initializeDataSource() {
138 private class UpdateThread
extends Thread
{
139 private final IProgressMonitor fMonitor
;
140 private final int fNumRequests
;
142 public UpdateThread(int numRequests
) {
143 super("Line chart update"); //$NON-NLS-1$
144 fNumRequests
= numRequests
;
145 fMonitor
= new NullProgressMonitor();
150 updateData(getWindowStartTime(), getWindowEndTime(), fNumRequests
, fMonitor
);
151 updateThreadFinished(this);
154 public void cancel() {
155 fMonitor
.setCanceled(true);
159 private synchronized void newUpdateThread() {
161 final int numRequests
= (int) (getSwtChart().getPlotArea().getBounds().width
* fResolution
);
162 fUpdateThread
= new UpdateThread(numRequests
);
163 fUpdateThread
.start();
166 private synchronized void updateThreadFinished(UpdateThread thread
) {
167 if (thread
== fUpdateThread
) {
168 fUpdateThread
= null;
173 * Cancels the currently running update thread. It is automatically called
174 * when the content is updated, but child viewers may want to call it
175 * manually to do some operations before calling
176 * {@link TmfCommonXLineChartViewer#updateContent}
178 protected synchronized void cancelUpdate() {
179 if (fUpdateThread
!= null) {
180 fUpdateThread
.cancel();
185 protected void updateContent() {
186 getDisplay().asyncExec(new Runnable() {
195 * Convenience method to compute the values of the X axis for a given time
196 * range. This method will return nb values depending, equally separated
199 * The returned time values are in internal time, ie to get trace time, the
200 * time offset needs to be added to those values.
203 * The start time of the time range
205 * End time of the range
207 * The number of steps in the x axis.
208 * @return The time values (converted to double) to match every step.
210 protected static final double[] getXAxis(long start
, long end
, int nb
) {
212 double timestamps
[] = new double[nb
];
213 long steps
= (end
- start
);
214 double step
= steps
/ (double) nb
;
217 for (int i
= 0; i
< nb
; i
++) {
218 timestamps
[i
] = curTime
;
225 * Set the values of the x axis. There is only one array of values for the x
226 * axis for all series of a line chart so it needs to be set once here.
229 * The values for the x axis. The values must be in internal
230 * time, ie time offset have been subtracted from trace time
233 protected final void setXAxis(double[] xaxis
) {
238 * Update the series data because the time range has changed. The x axis
239 * values for this data update can be computed using the
240 * {@link TmfCommonXLineChartViewer#getXAxis(long, long, int)} method which
241 * will return a list of uniformely separated time values.
243 * Each series values should be set by calling the
244 * {@link TmfCommonXLineChartViewer#setSeries(String, double[])}.
246 * This method is responsible for calling the
247 * {@link TmfCommonXLineChartViewer#updateDisplay()} when needed for the new
248 * values to be displayed.
251 * The start time of the range for which the get the data
253 * The end time of the range
255 * The number of 'points' in the chart.
257 * The progress monitor object
259 protected abstract void updateData(long start
, long end
, int nb
, IProgressMonitor monitor
);
262 * Set the data for a given series of the graph. The series does not need to
263 * be created before calling this, but it needs to have at least as many
264 * values as the x axis.
266 * If the series does not exist, it will automatically be created at display
267 * time, with the default values.
270 * The name of the series for which to set the values
271 * @param seriesValues
272 * The array of values for the series
274 protected void setSeries(String seriesName
, double[] seriesValues
) {
275 if (fXValues
.length
> seriesValues
.length
) {
276 throw new IllegalStateException();
278 fSeriesValues
.put(seriesName
, seriesValues
);
282 * Add a new series to the XY line chart. By default, it is a simple solid
286 * The name of the series to create
287 * @return The series so that the concrete viewer can modify its properties
290 protected ILineSeries
addSeries(String seriesName
) {
291 ISeriesSet seriesSet
= getSwtChart().getSeriesSet();
292 int seriesCount
= seriesSet
.getSeries().length
;
293 ILineSeries series
= (ILineSeries
) seriesSet
.createSeries(SeriesType
.LINE
, seriesName
);
294 series
.setVisible(true);
295 series
.enableArea(false);
296 series
.setLineStyle(LINE_STYLES
[(seriesCount
/ (LINE_COLORS
.length
)) % LINE_STYLES
.length
]);
297 series
.setSymbolType(PlotSymbolType
.NONE
);
298 series
.setLineColor(Display
.getDefault().getSystemColor(LINE_COLORS
[seriesCount
% LINE_COLORS
.length
]));
303 * Delete a series from the chart and its values from the viewer.
306 * Name of the series to delete
308 protected void deleteSeries(String seriesName
) {
309 ISeries series
= getSwtChart().getSeriesSet().getSeries(seriesName
);
310 if (series
!= null) {
311 getSwtChart().getSeriesSet().deleteSeries(series
.getId());
313 fSeriesValues
.remove(seriesName
);
317 * Update the chart's values before refreshing the viewer
319 protected void updateDisplay() {
320 Display
.getDefault().asyncExec(new Runnable() {
321 final TmfChartTimeStampFormat tmfChartTimeStampFormat
= new TmfChartTimeStampFormat(getTimeOffset());
325 if (!getSwtChart().isDisposed()) {
326 double[] xValues
= fXValues
;
327 if (xValues
.length
< 1) {
330 double maxy
= DEFAULT_MAXY
;
331 double miny
= DEFAULT_MINY
;
332 for (Entry
<String
, double[]> entry
: fSeriesValues
.entrySet()) {
333 ILineSeries series
= (ILineSeries
) getSwtChart().getSeriesSet().getSeries(entry
.getKey());
334 if (series
== null) {
335 series
= addSeries(entry
.getKey());
337 series
.setXSeries(xValues
);
338 /* Find the minimal and maximum values in this series */
339 for (double value
: entry
.getValue()) {
340 maxy
= Math
.max(maxy
, value
);
341 miny
= Math
.min(miny
, value
);
343 series
.setYSeries(entry
.getValue());
345 if (maxy
== DEFAULT_MAXY
) {
349 IAxisTick xTick
= getSwtChart().getAxisSet().getXAxis(0).getTick();
350 xTick
.setFormat(tmfChartTimeStampFormat
);
352 final double start
= xValues
[0];
353 int lastX
= xValues
.length
- 1;
354 double end
= (start
== xValues
[lastX
]) ? start
+ 1 : xValues
[lastX
];
355 getSwtChart().getAxisSet().getXAxis(0).setRange(new Range(start
, end
));
356 getSwtChart().getAxisSet().getXAxis(0).adjustRange();
358 getSwtChart().getAxisSet().getYAxis(0).setRange(new Range(miny
, maxy
));
360 getSwtChart().redraw();
362 if (isSendTimeAlignSignals()) {
363 // The width of the chart might have changed and its time
364 // axis might be misaligned with the other views
365 Point viewPos
= TmfCommonXLineChartViewer
.this.getParent().getParent().toDisplay(0, 0);
366 int axisPos
= getSwtChart().toDisplay(0, 0).x
+ getPointAreaOffset();
367 int timeAxisOffset
= axisPos
- viewPos
.x
;
368 TmfTimeViewAlignmentInfo timeAlignmentInfo
= new TmfTimeViewAlignmentInfo(getControl().getShell(), viewPos
, timeAxisOffset
);
369 TmfSignalManager
.dispatchSignal(new TmfTimeViewAlignmentSignal(TmfCommonXLineChartViewer
.this, timeAlignmentInfo
, true));
377 * Create the series once the initialization of the viewer's data source is
378 * done. Series do not need to be created before setting their values, but
379 * if their appearance needs to be customized, this method is a good place
380 * to do so. It is called only once per trace.
382 protected void createSeries() {
387 protected void clearContent() {
388 getSwtChart().getAxisSet().getXAxis(0).getTick().setFormat(null);
389 super.clearContent();