org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 2015 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.tracecompass.tmf.core.event;
  14
  15 import org.eclipse.core.runtime.IAdaptable;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
  18 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  19
  20 /**
  21  * The generic event structure in TMF. In its canonical form, an event has:
  22  * <ul>
  23  * <li>a parent trace
  24  * <li>a rank (order within the trace)
  25  * <li>a timestamp
  26  * <li>a type
  27  * <li>a content (payload)
  28  * </ul>
  29  *
  30  * @version 1.0
  31  * @author Francois Chouinard
  32  *
  33  * @see ITmfTimestamp
  34  * @see ITmfEventType
  35  * @see ITmfEventField
  36  * @see TmfEvent
  37  */
  38 public interface ITmfEvent extends IAdaptable {
  39
  40     // ------------------------------------------------------------------------
  41     // Getters
  42     // ------------------------------------------------------------------------
  43
  44     /**
  45      * @return the trace that 'owns' the event
  46      */
  47     @NonNull ITmfTrace getTrace();
  48
  49     /**
  50      * @return the event rank within the parent trace
  51      */
  52     long getRank();
  53
  54     /**
  55      * @return the event timestamp
  56      * @since 2.0
  57      */
  58     @NonNull ITmfTimestamp getTimestamp();
  59
  60     /**
  61      * @return the event type
  62      */
  63     ITmfEventType getType();
  64
  65     /**
  66      * @return the event content
  67      */
  68     ITmfEventField getContent();
  69 }