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 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
{
35 // ------------------------------------------------------------------------
37 // ------------------------------------------------------------------------
40 * Pre-defined event attributes
42 public static final String EVENT_FIELD_TIMESTAMP
= ":timestamp:"; //$NON-NLS-1$
43 public static final String EVENT_FIELD_SOURCE
= ":source:"; //$NON-NLS-1$
44 public static final String EVENT_FIELD_TYPE
= ":type:"; //$NON-NLS-1$
45 public static final String EVENT_FIELD_CONTENT
= ":content:"; //$NON-NLS-1$
46 public static final String EVENT_FIELD_REFERENCE
= ":reference:"; //$NON-NLS-1$
48 // ------------------------------------------------------------------------
50 // ------------------------------------------------------------------------
53 * @return the trace that 'owns' the event
55 public ITmfTrace
<?
> getTrace();
58 * @return the event rank within the parent trace
60 public long getRank();
63 * @return the event timestamp
65 public ITmfTimestamp
getTimestamp();
68 * @return the event source
70 public String
getSource();
73 * @return the event type
75 public ITmfEventType
getType();
78 * @return the event content
80 public ITmfEventField
getContent();
83 * @return the event reference
85 public String
getReference();
87 // ------------------------------------------------------------------------
89 // ------------------------------------------------------------------------
92 * @return a clone of the event
94 public ITmfEvent
clone();