projects / deliverable / tracecompass.git / blame
| Commit | Line | Data |
|---|---|---|
| 5d837f9b FC |
1 | /******************************************************************************* |
| 2 | * Copyright (c) 2012 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.core.trace; | |
| 14 | ||
| 15 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; | |
| 16 | ||
| 17 | /** | |
| 18 | * <b><u>ITmfCheckpoint</u></b> | |
| 19 | * <p> | |
| 20 | * The basic trace checkpoint structure in TMF. The purpose of the checkpoint is | |
| 21 | * to associate a trace location to an event timestamp. | |
| 22 | */ | |
| 23 | public interface ITmfCheckpoint extends Cloneable, Comparable<ITmfCheckpoint> { | |
| 24 | ||
| 25 | // ------------------------------------------------------------------------ | |
| 26 | // Getters | |
| 27 | // ------------------------------------------------------------------------ | |
| 28 | ||
| 29 | /** | |
| 30 | * @return the timestamp of the event referred to by the context | |
| 31 | */ | |
| 32 | public ITmfTimestamp getTimestamp(); | |
| 33 | ||
| 34 | /** | |
| 35 | * @return the location of the event referred to by the context | |
| 36 | */ | |
| 37 | public ITmfLocation<? extends Comparable<?>> getLocation(); | |
| 38 | ||
| 39 | // ------------------------------------------------------------------------ | |
| 40 | // Cloneable | |
| 41 | // ------------------------------------------------------------------------ | |
| 42 | ||
| 43 | /** | |
| 44 | * @return a clone of the checkpoint | |
| 45 | */ | |
| 46 | public ITmfCheckpoint clone(); | |
| 47 | ||
| 48 | // ------------------------------------------------------------------------ | |
| 49 | // Comparable | |
| 50 | // ------------------------------------------------------------------------ | |
| 51 | ||
| ff1ccee6 | 52 | /* (non-Javadoc) |
| 5d837f9b | 53 | * @see java.lang.Comparable#compareTo(java.lang.Object) |
| ff1ccee6 FC |
54 | * |
| 55 | * | |
| 5d837f9b FC |
56 | */ |
| 57 | @Override | |
| 58 | public int compareTo(ITmfCheckpoint checkpoint); | |
| 59 | ||
| 60 | } |