[287563] Updated TmfExperiment and TmfTrace.

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf / src / org / eclipse / linuxtools / tmf / event / TmfEvent.java

/*******************************************************************************
 * Copyright (c) 2009 Ericsson
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Francois Chouinard - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.event;

/**
 * <b><u>TmfEvent</u></b>
 * <p>
 * The basic event structure in the TMF. In its canonical form, an event has:
 * <ul>
 * <li> a normalized timestamp
 * <li> a source (reporter)
 * <li> a type
 * <li> a content
 * </ul>
 * For convenience, a free-form reference field is also provided. It could be
 * used as e.g. a location marker in the event stream to distinguish between
 * otherwise identical events.
 */
public class TmfEvent extends TmfData {

    // ========================================================================
    // Attributes
    // ========================================================================

	private final TmfTimestamp fEffectiveTimestamp;
	private final TmfTimestamp fOriginalTimestamp;
	private final TmfEventSource fSource;
	private final TmfEventType fType;
	private final TmfEventContent fContent;
	private final TmfEventReference fReference;

    // ========================================================================
    // Constructors
    // ========================================================================

	/**
	 * @param timestamp
	 * @param source
	 * @param type
	 * @param content
	 * @param reference
	 */
	public TmfEvent(TmfTimestamp originalTS, TmfTimestamp effectiveTS, TmfEventSource source,
			TmfEventType type, TmfEventContent content, TmfEventReference reference)
	{
		fOriginalTimestamp = originalTS;
		fEffectiveTimestamp = effectiveTS;
		fSource = source;
		fType = type;
		fContent = content;
		fReference = reference;
	}

	/**
	 * @param timestamp
	 * @param source
	 * @param type
	 * @param content
	 * @param reference
	 */
	public TmfEvent(TmfTimestamp timestamp, TmfEventSource source,
			TmfEventType type, TmfEventContent content, TmfEventReference reference)
	{
		this(timestamp, timestamp, source, type, content, reference);
	}

	/**
	 */
	public TmfEvent(TmfEvent other)
	{
		this(other.fOriginalTimestamp, other.fEffectiveTimestamp, other.fSource,
			 other.fType, other.fContent, other.fReference);
	}

    // ========================================================================
    // Accessors
    // ========================================================================

	/**
	 * @return
	 */
	public TmfTimestamp getTimestamp() {
		return fEffectiveTimestamp;
	}

	/**
	 * @return
	 */
	public TmfTimestamp getOriginalTimestamp() {
		return fOriginalTimestamp;
	}

	/**
	 * @return
	 */
	public TmfEventSource getSource() {
		return fSource;
	}

	/**
	 * @return
	 */
	public TmfEventType getType() {
		return fType;
	}

	/**
	 * @return
	 */
	public TmfEventContent getContent() {
		return fContent;
	}

	/**
	 * @return
	 */
	public TmfEventReference getReference() {
		return fReference;
	}

	// TODO: Design a proper format...
	@Override
	public String toString() {
		return fEffectiveTimestamp.toString();
	}
}