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 * Bernd Hufmann - Initial API and implementation in TmfXYChartViewer
11 * Geneviève Bastien - Moved methods from TmfXYChartViewer to this interface
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
;
16 import org
.eclipse
.swt
.widgets
.Composite
;
17 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
18 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
19 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalThrottler
;
20 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
21 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
22 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceRangeUpdatedSignal
;
23 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
24 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
25 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfWindowRangeUpdatedSignal
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
27 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
28 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceContext
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
34 * Abstract class that extends {@link TmfViewer} that adds methods to
35 * synchronize with a trace's time information.
37 * This class will be extended by viewers who require time information to update
41 * It provides three times of data:
42 * - start and end time of the trace (available)
43 * - start, end and duration of the current time window, ie the visible time range
44 * - start and end of the time range selected
47 * @author Bernd Hufmann
48 * @author Geneviève Bastien
50 public abstract class TmfTimeViewer
extends TmfViewer
implements ITmfTimeProvider
{
52 /** Start time of trace */
53 private long fStartTime
;
54 /** End time of trace */
55 private long fEndTime
;
56 /** Start time of current time range */
57 private long fWindowStartTime
;
58 /** End time of current time range */
59 private long fWindowEndTime
;
60 /** Current begin time of selection range */
61 private long fSelectionBeginTime
;
62 /** Current end of selection range */
63 private long fSelectionEndTime
;
64 /** The trace that is displayed by this viewer */
65 private ITmfTrace fTrace
;
66 /** A signal throttler for range updates */
67 private final TmfSignalThrottler fTimeRangeSyncThrottle
= new TmfSignalThrottler(this, 200);
70 * Default constructor.
72 public TmfTimeViewer() {
77 * Constructor that initializes the parent of the viewer
80 * The parent composite that holds this viewer
82 public TmfTimeViewer(Composite parent
) {
83 this(parent
, ""); //$NON-NLS-1$
87 * Constructor that initializes the parent of the viewer and that sets the
91 * The parent composite that holds this viewer
93 * The name of the viewer
95 public TmfTimeViewer(Composite parent
, String name
) {
99 // ------------------------------------------------------------------------
101 // ------------------------------------------------------------------------
104 * Sets the start time of the trace
107 * The start time to set
109 protected void setStartTime(long startTime
) {
110 fStartTime
= startTime
;
114 * Sets the end time of the trace
117 * The start time to set
119 protected void setEndTime(long endTime
) {
124 * Sets the start time and end of the current time range window (visible
127 * @param windowStartTime
128 * The start time to set
129 * @param windowEndTime
130 * The start time to set
133 protected void setWindowRange(long windowStartTime
, long windowEndTime
) {
134 fWindowStartTime
= windowStartTime
;
135 fWindowEndTime
= windowEndTime
;
139 * Sets the begin and end time of the selected range without sending the
140 * {@link TmfSelectionRangeUpdatedSignal} signal.
142 * @param selectionBeginTime
143 * The begin time to set
144 * @param selectionEndTime
145 * The end time to set
149 protected void setSelectionRange(long selectionBeginTime
, long selectionEndTime
) {
150 fSelectionBeginTime
= selectionBeginTime
;
151 fSelectionEndTime
= selectionEndTime
;
155 * Sets the trace that is displayed by this viewer.
160 protected void setTrace(ITmfTrace trace
) {
165 * Gets the trace that is displayed by this viewer.
169 protected ITmfTrace
getTrace() {
173 // ------------------------------------------------------------------------
175 // ------------------------------------------------------------------------
178 public long getStartTime() {
183 public long getEndTime() {
188 public long getWindowStartTime() {
189 return fWindowStartTime
;
193 public long getWindowEndTime() {
194 return fWindowEndTime
;
198 public long getWindowDuration() {
199 return getWindowEndTime() - getWindowStartTime();
203 public long getSelectionBeginTime() {
204 return fSelectionBeginTime
;
208 public long getSelectionEndTime() {
209 return fSelectionEndTime
;
213 public void updateSelectionRange(final long currentBeginTime
, final long currentEndTime
) {
214 if (fTrace
!= null) {
215 setSelectionRange(currentBeginTime
, currentEndTime
);
217 final ITmfTimestamp startTimestamp
= new TmfTimestamp(getSelectionBeginTime(), ITmfTimestamp
.NANOSECOND_SCALE
);
218 final ITmfTimestamp endTimestamp
= new TmfTimestamp(getSelectionEndTime(), ITmfTimestamp
.NANOSECOND_SCALE
);
220 TmfSelectionRangeUpdatedSignal signal
= new TmfSelectionRangeUpdatedSignal(this, startTimestamp
, endTimestamp
);
226 public void updateWindow(long windowStartTime
, long windowEndTime
) {
228 setWindowRange(windowStartTime
, windowEndTime
);
230 // Build the new time range; keep the current time
231 TmfTimeRange timeRange
= new TmfTimeRange(
232 new TmfTimestamp(getWindowStartTime(), ITmfTimestamp
.NANOSECOND_SCALE
),
233 new TmfTimestamp(getWindowEndTime(), ITmfTimestamp
.NANOSECOND_SCALE
));
236 TmfWindowRangeUpdatedSignal signal
= new TmfWindowRangeUpdatedSignal(this, timeRange
);
237 fTimeRangeSyncThrottle
.queue(signal
);
240 // ------------------------------------------------------------------------
242 // ------------------------------------------------------------------------
244 * A Method to load a trace into the viewer.
247 * A trace to apply in the viewer
249 public void loadTrace(ITmfTrace trace
) {
252 TmfTraceContext ctx
= TmfTraceManager
.getInstance().getCurrentTraceContext();
253 long selectionStart
= ctx
.getSelectionRange().getStartTime().toNanos();
254 long selectionEnd
= ctx
.getSelectionRange().getEndTime().toNanos();
255 TmfTimeRange windowRange
= ctx
.getWindowRange();
257 long windowStartTime
= windowRange
.getStartTime().toNanos();
258 long windowEndTime
= windowRange
.getEndTime().toNanos();
259 long startTime
= fTrace
.getStartTime().toNanos();
260 long endTime
= fTrace
.getEndTime().toNanos();
262 setSelectionRange(selectionStart
, selectionEnd
);
264 setStartTime(startTime
);
265 setWindowRange(windowStartTime
, windowEndTime
);
270 * Resets the content of the viewer
272 public void reset() {
273 // Reset the internal data
274 setSelectionRange(0, 0);
276 setWindowRange(0, 0);
281 // ------------------------------------------------------------------------
283 // ------------------------------------------------------------------------
286 * Signal handler for handling of the trace opened signal.
289 * The trace opened signal {@link TmfTraceOpenedSignal}
292 public void traceOpened(TmfTraceOpenedSignal signal
) {
293 fTrace
= signal
.getTrace();
294 loadTrace(getTrace());
298 * Signal handler for handling of the trace selected signal.
301 * The trace selected signal {@link TmfTraceSelectedSignal}
304 public void traceSelected(TmfTraceSelectedSignal signal
) {
305 if (fTrace
!= signal
.getTrace()) {
306 fTrace
= signal
.getTrace();
307 loadTrace(getTrace());
312 * Signal handler for handling of the trace closed signal.
315 * The trace closed signal {@link TmfTraceClosedSignal}
318 public void traceClosed(TmfTraceClosedSignal signal
) {
320 if (signal
.getTrace() != fTrace
) {
324 // Reset the internal data
330 * Signal handler for handling of the selected range signal.
333 * The {@link TmfSelectionRangeUpdatedSignal}
337 public void selectionRangeUpdated(TmfSelectionRangeUpdatedSignal signal
) {
338 if ((signal
.getSource() != this) && (fTrace
!= null)) {
339 long selectedTime
= signal
.getBeginTime().toNanos();
340 long selectedEndTime
= signal
.getEndTime().toNanos();
341 setSelectionRange(selectedTime
, selectedEndTime
);
346 * Signal handler for handling of the window range signal.
349 * The {@link TmfWindowRangeUpdatedSignal}
353 public void windowRangeUpdated(TmfWindowRangeUpdatedSignal signal
) {
355 if (fTrace
!= null) {
356 // Validate the time range
357 TmfTimeRange range
= signal
.getCurrentRange().getIntersection(fTrace
.getTimeRange());
362 if (signal
.getSource() != this) {
363 // Update the time range
364 long windowStartTime
= range
.getStartTime().toNanos();
365 long windowEndTime
= range
.getEndTime().toNanos();
367 setWindowRange(windowStartTime
, windowEndTime
);
373 * Signal handler for handling of the trace range updated signal.
376 * The trace range signal {@link TmfTraceRangeUpdatedSignal}
379 public void traceRangeUpdated(TmfTraceRangeUpdatedSignal signal
) {
381 if (signal
.getTrace() != fTrace
) {
385 TmfTimeRange fullRange
= signal
.getRange();
387 long traceStartTime
= fullRange
.getStartTime().toNanos();
388 long traceEndTime
= fullRange
.getEndTime().toNanos();
390 setStartTime(traceStartTime
);
391 setEndTime(traceEndTime
);
395 * Signal handler for handling of the trace updated signal.
398 * The trace updated signal {@link TmfTraceUpdatedSignal}
401 public void traceUpdated(TmfTraceUpdatedSignal signal
) {
402 if (signal
.getTrace() != fTrace
) {
405 TmfTimeRange fullRange
= signal
.getTrace().getTimeRange();
407 long traceStartTime
= fullRange
.getStartTime().toNanos();
408 long traceEndTime
= fullRange
.getEndTime().toNanos();
410 setStartTime(traceStartTime
);
411 setEndTime(traceEndTime
);