Commit | Line | Data |
---|---|---|
5d837f9b | 1 | /******************************************************************************* |
ea271da6 | 2 | * Copyright (c) 2012, 2013 Ericsson |
1e1bef82 | 3 | * |
5d837f9b FC |
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 | |
1e1bef82 | 8 | * |
5d837f9b FC |
9 | * Contributors: |
10 | * Francois Chouinard - Initial API and implementation | |
ea271da6 | 11 | * Patrick Tasse - Updated for location in checkpoint |
5d837f9b FC |
12 | *******************************************************************************/ |
13 | ||
14 | package org.eclipse.linuxtools.tmf.core.trace; | |
15 | ||
3bd46eef | 16 | import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp; |
5d837f9b FC |
17 | |
18 | /** | |
5d837f9b FC |
19 | * The basic trace checkpoint structure in TMF. The purpose of the checkpoint is |
20 | * to associate a trace location to an event timestamp. | |
1e1bef82 | 21 | * |
f7703ed6 FC |
22 | * @version 1.0 |
23 | * @author Francois Chouinard | |
24 | * | |
f7703ed6 FC |
25 | * @see ITmfTimestamp |
26 | * @see ITmfLocation | |
5d837f9b | 27 | */ |
0316808c | 28 | public interface ITmfCheckpoint extends Comparable<ITmfCheckpoint> { |
5d837f9b FC |
29 | |
30 | // ------------------------------------------------------------------------ | |
31 | // Getters | |
32 | // ------------------------------------------------------------------------ | |
33 | ||
34 | /** | |
3bd46eef AM |
35 | * @return the timestamp of the event referred to by the context |
36 | * @since 2.0 | |
5d837f9b FC |
37 | */ |
38 | public ITmfTimestamp getTimestamp(); | |
39 | ||
d905a64a | 40 | /** |
ea271da6 | 41 | * @return the location of the event referred to by the checkpoint |
5d837f9b | 42 | */ |
1e1bef82 | 43 | public ITmfLocation getLocation(); |
5d837f9b | 44 | |
5d837f9b FC |
45 | // ------------------------------------------------------------------------ |
46 | // Comparable | |
47 | // ------------------------------------------------------------------------ | |
48 | ||
5d837f9b FC |
49 | @Override |
50 | public int compareTo(ITmfCheckpoint checkpoint); | |
51 | ||
52 | } |