org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/ITmfTrace.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  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.trace;
  14
  15 import org.eclipse.linuxtools.tmf.event.TmfEvent;
  16 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
  17 import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
  18
  19 /**
  20  * <b><u>ITmfTrace</u></b>
  21  * <p>
  22  */
  23 public interface ITmfTrace {
  24
  25         /**
  26          * @return the trace path
  27          */
  28         public String getPath();
  29
  30         /**
  31          * @return the trace name
  32          */
  33         public String getName();
  34
  35         /**
  36          * @return the number of events in the trace
  37          */
  38         public long getNbEvents();
  39
  40         /**
  41          * Trace time range accessors
  42          */
  43         public TmfTimeRange getTimeRange();
  44     public TmfTimestamp getStartTime();
  45     public TmfTimestamp getEndTime();
  46
  47     /**
  48      * Positions the trace at the first event with the specified
  49      * timestamp or index (i.e. the nth event in the trace).
  50      *
  51      * Returns a context which can later be used to read the event.
  52      *
  53      * @param data.timestamp
  54      * @param data.index
  55      * @return a context object for subsequent reads
  56      */
  57     public TmfTraceContext seekLocation(Object location);
  58     public TmfTraceContext seekEvent(TmfTimestamp timestamp);
  59     public TmfTraceContext seekEvent(long index);
  60
  61     /**
  62      * Return the event pointed by the supplied context (or null if
  63      * no event left) and updates the context to the next event.
  64      *
  65      * @return the next event in the stream
  66      */
  67     public TmfEvent getNextEvent(TmfTraceContext context);
  68
  69 }