tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/ITmfTimeProvider.java

   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
  14 package org.eclipse.tracecompass.tmf.ui.viewers;
  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  */
  23 public interface ITmfTimeProvider extends ITmfViewer {
  24
  25     /**
  26      * Gets the start time of trace
  27      *
  28      * @return start time of trace
  29      */
  30     long getStartTime();
  31
  32     /**
  33      * Gets the end time of trace
  34      *
  35      * @return End time of trace
  36      */
  37     long getEndTime();
  38
  39     /**
  40      * Gets the start time of current time range displayed
  41      *
  42      * @return start time of current time range
  43      */
  44     long getWindowStartTime();
  45
  46     /**
  47      * Gets the end time of current time range displayed
  48      *
  49      * @return End time of current time range
  50      */
  51     long getWindowEndTime();
  52
  53     /**
  54      * Gets the duration of the current time range displayed
  55      *
  56      * @return duration of current time range
  57      */
  58     long getWindowDuration();
  59
  60     /**
  61      * Gets the begin time of the selected range
  62      *
  63      * @return the begin time of the selected range
  64      */
  65     long getSelectionBeginTime();
  66
  67     /**
  68      * Gets the end time of the selected range
  69      *
  70      * @return end time of the selected range
  71      */
  72     long getSelectionEndTime();
  73
  74     /**
  75      * Method to notify about a change of the current selected time.
  76      *
  77      * @param currentBeginTime
  78      *            The current selection begin time
  79      * @param currentEndTime
  80      *            The current selection end time
  81      */
  82     void updateSelectionRange(long currentBeginTime, long currentEndTime);
  83
  84     /**
  85      * Updates the current time range window.
  86      *
  87      * @param windowStartTime
  88      *            The window start time
  89      * @param windowEndTime
  90      *            The window end time.
  91      */
  92     void updateWindow(long windowStartTime, long windowEndTime);
  93
  94 }