org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/model/ITmfTimeAnalysisEntry.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009 Ericsson
   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  *   Alvaro Sanchez-Leon - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model;
  14
  15 import java.util.Iterator;
  16 import java.util.Vector;
  17
  18 public interface ITmfTimeAnalysisEntry {
  19
  20     public String getGroupName();
  21
  22         public int getId();
  23
  24         public String getName();
  25
  26         public long getStartTime();
  27
  28         public long getStopTime();
  29
  30     /**
  31      * Get a vector containing all events
  32      * @deprecated replaced by {@link #getTraceEventsIterator()}
  33      */
  34     @Deprecated public <T extends ITimeEvent> Vector<T> getTraceEvents();
  35
  36     /**
  37      * Get an iterator which returns all events
  38      */
  39     public <T extends ITimeEvent> Iterator<T> getTraceEventsIterator();
  40
  41     /**
  42      * Get an iterator which only returns events that fall within the start time and the stop time.
  43      * The visible duration is the event duration below which further detail is not discernible.
  44      * If no such iterator is implemented, provide a basic iterator which returns all events.
  45      *
  46      * @param startTime start time in nanoseconds
  47      * @param stopTime stop time in nanoseconds
  48      * @param visibleDuration duration of one pixel in nanoseconds
  49      */
  50     public <T extends ITimeEvent> Iterator<T> getTraceEventsIterator(long startTime, long stopTime, long visibleDuration);
  51
  52     public <T extends ITimeEvent> void addTraceEvent(T event);
  53 }