1 /*******************************************************************************
2 * Copyright (c) 2009, 2011 Ericsson
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
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.trace
;
15 import java
.io
.FileNotFoundException
;
17 import org
.eclipse
.core
.resources
.IProject
;
18 import org
.eclipse
.linuxtools
.tmf
.component
.ITmfComponent
;
19 import org
.eclipse
.linuxtools
.tmf
.event
.TmfEvent
;
20 import org
.eclipse
.linuxtools
.tmf
.event
.TmfTimeRange
;
21 import org
.eclipse
.linuxtools
.tmf
.event
.TmfTimestamp
;
24 * <b><u>ITmfTrace</u></b>
27 public interface ITmfTrace
<T
extends TmfEvent
> extends ITmfComponent
{
30 public void initTrace(String path
, Class
<T
> eventType
) throws FileNotFoundException
;
32 public void initTrace(String path
, Class
<T
> eventType
, int cacheSize
) throws FileNotFoundException
;
34 public void initTrace(String path
, Class
<T
> eventType
, boolean indexTrace
) throws FileNotFoundException
;
36 public void initTrace(String path
, Class
<T
> eventType
, int cacheSize
, boolean indexTrace
) throws FileNotFoundException
;
38 // Trace type validation
39 public boolean validate(IProject project
, String path
);
41 public ITmfTrace
<T
> copy();
44 * @return the trace path
46 public String
getPath();
49 * @return the trace name
52 public String
getName();
55 * @return the cache size
57 public int getCacheSize();
60 * @return the number of events in the trace
62 public long getNbEvents();
65 * Trace time range accesses
67 public TmfTimeRange
getTimeRange();
69 public TmfTimestamp
getStartTime();
71 public TmfTimestamp
getEndTime();
74 * Positions the trace at the first event with the specified timestamp or index (i.e. the nth event in the trace).
76 * Returns a context which can later be used to read the event.
81 * @return a context object for subsequent reads
83 public TmfContext
seekLocation(ITmfLocation
<?
> location
);
85 public TmfContext
seekEvent(TmfTimestamp timestamp
);
87 public TmfContext
seekEvent(long rank
);
90 * Positions the trace at the event located at the specified ratio.
92 * Returns a context which can later be used to read the event.
95 * a floating-point number between 0.0 (beginning) and 1.0 (end)
96 * @return a context object for subsequent reads
98 public TmfContext
seekLocation(double ratio
);
101 * Returns the ratio corresponding to the specified location.
105 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
107 public double getLocationRatio(ITmfLocation
<?
> location
);
109 public ITmfLocation
<?
> getCurrentLocation();
112 * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
118 public long getRank(TmfTimestamp timestamp
);
121 * Return the event pointed by the supplied context (or null if no event left) and updates the context to the next
124 * @return the next event in the stream
126 public TmfEvent
getNextEvent(TmfContext context
);
129 * Return the event pointed by the supplied context (or null if no event left) and *does not* update the context.
131 * @return the next event in the stream
133 public TmfEvent
parseEvent(TmfContext context
);
This page took 0.042324 seconds and 5 git commands to generate.