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.component.ITmfComponent;
  16 import org.eclipse.linuxtools.tmf.event.TmfEvent;
  17 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
  18 import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
  19
  20 /**
  21  * <b><u>ITmfTrace</u></b>
  22  * <p>
  23  */
  24 public interface ITmfTrace extends ITmfComponent {
  25
  26         public ITmfTrace createTraceCopy();
  27
  28
  29         /**
  30          * @return the trace path
  31          */
  32         public String getPath();
  33
  34         /**
  35          * @return the trace name
  36          */
  37         public String getName();
  38
  39         /**
  40          * @return the number of events in the trace
  41          */
  42         public long getNbEvents();
  43
  44         /**
  45          * Trace time range accessors
  46          */
  47         public TmfTimeRange getTimeRange();
  48     public TmfTimestamp getStartTime();
  49     public TmfTimestamp getEndTime();
  50
  51         /**
  52      * Positions the trace at the first event with the specified
  53      * timestamp or index (i.e. the nth event in the trace).
  54      *
  55      * Returns a context which can later be used to read the event.
  56      *
  57      * @param data.timestamp
  58      * @param data.index
  59      * @return a context object for subsequent reads
  60      */
  61     public TmfContext seekLocation(ITmfLocation<?> location);
  62     public TmfContext seekEvent(TmfTimestamp timestamp);
  63     public TmfContext seekEvent(long rank);
  64
  65     /**
  66      * Return the event pointed by the supplied context (or null if
  67      * no event left) and updates the context to the next event.
  68      *
  69      * @return the next event in the stream
  70      */
  71     public TmfEvent getNextEvent(TmfContext context);
  72
  73     /**
  74      * Return the event pointed by the supplied context (or null if
  75      * no event left) and *does not* update the context.
  76      *
  77      * @return the next event in the stream
  78      */
  79     public TmfEvent parseEvent(TmfContext context);
  80
  81 }