org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2011 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.core.trace;
  14
  15 import java.io.FileNotFoundException;
  16
  17 import org.eclipse.core.resources.IProject;
  18 import org.eclipse.linuxtools.tmf.core.component.ITmfComponent;
  19 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
  20 import org.eclipse.linuxtools.tmf.core.event.TmfEvent;
  21 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
  22
  23 /**
  24  * <b><u>ITmfTrace</u></b>
  25  * <p>
  26  */
  27 public interface ITmfTrace<T extends TmfEvent> extends ITmfComponent {
  28
  29     // initTrace variants
  30     public void initTrace(String name, String path, Class<T> eventType) throws FileNotFoundException;
  31
  32     public void initTrace(String name, String path, Class<T> eventType, int cacheSize) throws FileNotFoundException;
  33
  34     public void initTrace(String name, String path, Class<T> eventType, boolean indexTrace) throws FileNotFoundException;
  35
  36     public void initTrace(String name, String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException;
  37
  38     // Trace type validation
  39     public boolean validate(IProject project, String path);
  40
  41     public ITmfTrace<T> copy();
  42
  43     /**
  44      * @return the trace path
  45      */
  46     public String getPath();
  47
  48     /**
  49      * @return the trace name
  50      */
  51     @Override
  52     public String getName();
  53
  54     /**
  55      * @return the cache size
  56      */
  57     public int getCacheSize();
  58
  59     /**
  60      * @return the number of events in the trace
  61      */
  62     public long getNbEvents();
  63
  64     /**
  65      * Trace time range accesses
  66      */
  67     public TmfTimeRange getTimeRange();
  68
  69     public ITmfTimestamp getStartTime();
  70
  71     public ITmfTimestamp getEndTime();
  72
  73     /**
  74      * @return the streaming interval in ms (0 if not streaming)
  75      */
  76     public long getStreamingInterval();
  77
  78     /**
  79      * Positions the trace at the first event with the specified timestamp or index (i.e. the nth event in the trace).
  80      *
  81      * Returns a context which can later be used to read the event.
  82      *
  83      * @param location
  84      * @param timestamp
  85      * @param rank
  86      * @return a context object for subsequent reads
  87      */
  88     public TmfContext seekLocation(ITmfLocation<?> location);
  89
  90     public TmfContext seekEvent(ITmfTimestamp timestamp);
  91
  92     public TmfContext seekEvent(long rank);
  93
  94     /**
  95      * Positions the trace at the event located at the specified ratio.
  96      *
  97      * Returns a context which can later be used to read the event.
  98      *
  99      * @param ratio
 100      *            a floating-point number between 0.0 (beginning) and 1.0 (end)
 101      * @return a context object for subsequent reads
 102      */
 103     public TmfContext seekLocation(double ratio);
 104
 105     /**
 106      * Returns the ratio corresponding to the specified location.
 107      *
 108      * @param location
 109      *            a trace location
 110      * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
 111      */
 112     public double getLocationRatio(ITmfLocation<?> location);
 113
 114     public ITmfLocation<?> getCurrentLocation();
 115
 116     /**
 117      * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
 118      * (if any).
 119      *
 120      * @param timestamp
 121      * @return
 122      */
 123     public long getRank(ITmfTimestamp timestamp);
 124
 125     /**
 126      * Return the event pointed by the supplied context (or null if no event left) and updates the context to the next
 127      * event.
 128      *
 129      * @return the next event in the stream
 130      */
 131     public TmfEvent getNextEvent(TmfContext context);
 132
 133     /**
 134      * Return the event pointed by the supplied context (or null if no event left) and *does not* update the context.
 135      *
 136      * @return the next event in the stream
 137      */
 138     public TmfEvent parseEvent(TmfContext context);
 139
 140 }