1 /*******************************************************************************
2 * Copyright (c) 2009 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 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
;
21 * <b><u>ITmfTrace</u></b>
24 public interface ITmfTrace
extends ITmfComponent
{
26 public ITmfTrace
createTraceCopy();
29 * @return the trace path
31 public String
getPath();
34 * @return the trace name
37 public String
getName();
40 * @return the cache size
42 public int getCacheSize();
45 * @return the number of events in the trace
47 public long getNbEvents();
50 * Trace time range accessors
52 public TmfTimeRange
getTimeRange();
53 public TmfTimestamp
getStartTime();
54 public TmfTimestamp
getEndTime();
57 * Positions the trace at the first event with the specified
58 * timestamp or index (i.e. the nth event in the trace).
60 * Returns a context which can later be used to read the event.
62 * @param data.timestamp
64 * @return a context object for subsequent reads
66 public TmfContext
seekLocation(ITmfLocation
<?
> location
);
67 public TmfContext
seekEvent(TmfTimestamp timestamp
);
68 public TmfContext
seekEvent(long rank
);
71 * Returns the rank of the first event with the requested timestamp.
72 * If none, returns the index of the next event (if any).
77 public long getRank(TmfTimestamp timestamp
);
80 * Return the event pointed by the supplied context (or null if
81 * no event left) and updates the context to the next event.
83 * @return the next event in the stream
85 public TmfEvent
getNextEvent(TmfContext context
);
88 * Return the event pointed by the supplied context (or null if
89 * no event left) and *does not* update the context.
91 * @return the next event in the stream
93 public TmfEvent
parseEvent(TmfContext context
);
This page took 0.032143 seconds and 5 git commands to generate.