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
36 public String
getName();
39 * @return the number of events in the trace
41 public long getNbEvents();
44 * Trace time range accessors
46 public TmfTimeRange
getTimeRange();
47 public TmfTimestamp
getStartTime();
48 public TmfTimestamp
getEndTime();
51 * Positions the trace at the first event with the specified
52 * timestamp or index (i.e. the nth event in the trace).
54 * Returns a context which can later be used to read the event.
56 * @param data.timestamp
58 * @return a context object for subsequent reads
60 public TmfContext
seekLocation(ITmfLocation
<?
> location
);
61 public TmfContext
seekEvent(TmfTimestamp timestamp
);
62 public TmfContext
seekEvent(long rank
);
65 * Return the event pointed by the supplied context (or null if
66 * no event left) and updates the context to the next event.
68 * @return the next event in the stream
70 public TmfEvent
getNextEvent(TmfContext context
);
73 * Return the event pointed by the supplied context (or null if
74 * no event left) and *does not* update the context.
76 * @return the next event in the stream
78 public TmfEvent
parseEvent(TmfContext context
);
This page took 0.037075 seconds and 5 git commands to generate.