1 /*******************************************************************************
2 * Copyright (c) 2012 Ericsson
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
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.event
;
15 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
18 * <b><u>ITmfEvent</u></b>
20 * The basic event structure in the TMF. In its canonical form, a data item has:
23 * <li> a rank (order within the trace)
25 * <li> a source (reporting component)
27 * <li> a content (payload)
29 * For convenience, a free-form reference field is also provided. It could be
30 * used as e.g. a location marker (filename:lineno) to indicate where the event
33 public interface ITmfEvent
extends Cloneable
{
36 * Pre-defined event attributes
38 public String EVENT_FIELD_TIMESTAMP
= ":timestamp:"; //$NON-NLS-1$
39 public String EVENT_FIELD_SOURCE
= ":source:"; //$NON-NLS-1$
40 public String EVENT_FIELD_TYPE
= ":type:"; //$NON-NLS-1$
41 public String EVENT_FIELD_CONTENT
= ":content:"; //$NON-NLS-1$
42 public String EVENT_FIELD_REFERENCE
= ":reference:"; //$NON-NLS-1$
45 * @return the trace that 'owns' the event
47 public ITmfTrace
<?
> getTrace();
50 * @return the event rank within the parent trace
52 public long getRank();
55 * @return the event timestamp
57 public ITmfTimestamp
getTimestamp();
60 * @return the event source
62 public String
getSource();
65 * @return the event type
67 public ITmfEventType
getType();
70 * @return the event content
72 public ITmfEventField
getContent();
75 * @return the event reference
77 public String
getReference();
80 * @return a clone of the data item
82 public ITmfEvent
clone();