Commit | Line | Data |
---|---|---|
843c272b 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 | * Bernd Hufmann - Initial API and implementation in ITmfChartTimeProvider | |
11 | * Geneviève Bastien - Moved methods from ITmfChartTimeProvider to this interface | |
12 | *******************************************************************************/ | |
13 | ||
2bdf0193 | 14 | package org.eclipse.tracecompass.tmf.ui.viewers; |
843c272b GB |
15 | |
16 | /** | |
17 | * Interface for providing and updating time information. This is typically | |
18 | * implemented by a viewer that is displaying trace data over time. | |
19 | * | |
20 | * @author Bernd Hufmann | |
21 | * @author Geneviève Bastien | |
22 | * @since 3.0 | |
23 | */ | |
24 | public interface ITmfTimeProvider extends ITmfViewer { | |
25 | ||
26 | /** | |
27 | * Gets the start time of trace | |
28 | * | |
29 | * @return start time of trace | |
30 | */ | |
31 | long getStartTime(); | |
32 | ||
33 | /** | |
34 | * Gets the end time of trace | |
35 | * | |
36 | * @return End time of trace | |
37 | */ | |
38 | long getEndTime(); | |
39 | ||
40 | /** | |
41 | * Gets the start time of current time range displayed | |
42 | * | |
43 | * @return start time of current time range | |
44 | */ | |
45 | long getWindowStartTime(); | |
46 | ||
47 | /** | |
48 | * Gets the end time of current time range displayed | |
49 | * | |
50 | * @return End time of current time range | |
51 | */ | |
52 | long getWindowEndTime(); | |
53 | ||
54 | /** | |
55 | * Gets the duration of the current time range displayed | |
56 | * | |
57 | * @return duration of current time range | |
58 | */ | |
59 | long getWindowDuration(); | |
60 | ||
61 | /** | |
62 | * Gets the begin time of the selected range | |
63 | * | |
64 | * @return the begin time of the selected range | |
65 | */ | |
66 | long getSelectionBeginTime(); | |
67 | ||
68 | /** | |
69 | * Gets the end time of the selected range | |
70 | * | |
71 | * @return end time of the selected range | |
72 | */ | |
73 | long getSelectionEndTime(); | |
74 | ||
75 | /** | |
76 | * Method to notify about a change of the current selected time. | |
77 | * | |
78 | * @param currentBeginTime | |
79 | * The current selection begin time | |
80 | * @param currentEndTime | |
81 | * The current selection end time | |
82 | */ | |
83 | void updateSelectionRange(long currentBeginTime, long currentEndTime); | |
84 | ||
85 | /** | |
86 | * Updates the current time range window. | |
87 | * | |
88 | * @param windowStartTime | |
89 | * The window start time | |
90 | * @param windowEndTime | |
91 | * The window end time. | |
92 | */ | |
93 | void updateWindow(long windowStartTime, long windowEndTime); | |
94 | ||
95 | } |