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

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