org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfCheckpoint.java

   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  * The basic trace checkpoint structure in TMF. The purpose of the checkpoint is
  19  * to associate a trace location to an event timestamp.
  20  *
  21  * @version 1.0
  22  * @author Francois Chouinard
  23  *
  24  * @see ITmfTimestamp
  25  * @see ITmfLocation
  26  */
  27 public interface ITmfCheckpoint extends Comparable<ITmfCheckpoint> {
  28
  29     // ------------------------------------------------------------------------
  30     // Getters
  31     // ------------------------------------------------------------------------
  32
  33     /**
  34      * @return the timestamp of the event referred to by the context
  35      */
  36     public ITmfTimestamp getTimestamp();
  37
  38     /**
  39      * @return the location of the event referred to by the context
  40      */
  41     public ITmfContext getContext();
  42
  43     /**
  44      * @return the location of the event referred to by the context
  45      */
  46     public ITmfLocation getLocation();
  47
  48     /**
  49      * @return a clone of the checkpoint
  50      */
  51     public ITmfCheckpoint clone();
  52
  53     // ------------------------------------------------------------------------
  54     // Comparable
  55     // ------------------------------------------------------------------------
  56
  57     /* (non-Javadoc)
  58      * @see java.lang.Comparable#compareTo(java.lang.Object)
  59      */
  60     @Override
  61     public int compareTo(ITmfCheckpoint checkpoint);
  62
  63 }