1 /*******************************************************************************
2 * Copyright (c) 2009, 2014 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 * Francois Chouinard - Updated as per TMF Trace Model 1.0
12 * Patrick Tasse - Updated for removal of context clone
13 *******************************************************************************/
15 package org
.eclipse
.tracecompass
.tmf
.core
.trace
;
17 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
20 * The basic trace context structure in TMF. The purpose of the context is to
21 * associate a trace location to an event at a specific rank (order).
23 * The context should be sufficient to allow the trace to position itself so
24 * that performing a trace read operation will yield the corresponding 'nth'
28 * @author Francois Chouinard
32 public interface ITmfContext
{
34 // ------------------------------------------------------------------------
36 // ------------------------------------------------------------------------
39 * The unknown event rank
41 public long UNKNOWN_RANK
= -1L;
43 // ------------------------------------------------------------------------
45 // ------------------------------------------------------------------------
48 * @return the rank of the event at the context location
53 * @return the location of the event at the context rank
55 ITmfLocation
getLocation();
58 * @return indicates if the context rank is valid (!= UNKNOWN_RANK)
60 boolean hasValidRank();
62 // ------------------------------------------------------------------------
64 // ------------------------------------------------------------------------
67 * @param location the new location
69 void setLocation(ITmfLocation location
);
72 * @param rank the new rank
74 void setRank(long rank
);
77 * Increment the context rank
This page took 0.03179 seconds and 5 git commands to generate.