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