1 /*******************************************************************************
2 * Copyright (c) 2009, 2010, 2012 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 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.core
.trace
;
17 * The basic trace context structure in TMF. The purpose of the context is to
18 * associate a trace location to an event of a specific rank (order).
20 * The context should be sufficient to allow the trace to position itself so
21 * that performing a trace read operation will yield the corresponding event.
25 * @author Francois Chouinard
29 public interface ITmfContext
extends Cloneable
{
31 // ------------------------------------------------------------------------
33 // ------------------------------------------------------------------------
36 * The unknown event rank
38 public long UNKNOWN_RANK
= -1L;
40 // ------------------------------------------------------------------------
42 // ------------------------------------------------------------------------
45 * @return the rank of the event referred to by the context
47 public long getRank();
50 * @return the location of the event referred to by the context
52 public ITmfLocation
<?
extends Comparable
<?
>> getLocation();
55 * @return indicates if the context rank is valid (!= UNKNOWN_RANK)
57 public boolean hasValidRank();
59 // ------------------------------------------------------------------------
61 // ------------------------------------------------------------------------
64 * @param location the new location
66 public void setLocation(ITmfLocation
<?
extends Comparable
<?
>> location
);
69 * @param rank the new rank
71 public void setRank(long rank
);
74 * Increment the context rank
76 public void increaseRank();
81 public void dispose();
83 // ------------------------------------------------------------------------
85 // ------------------------------------------------------------------------
88 * @return a clone of the context
90 public ITmfContext
clone();
This page took 0.03795 seconds and 6 git commands to generate.