2010-11-10 Francois Chouinard <fchouinard@gmail.com> Contribution for Bug315307

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / model / trange / TimeRangeEvent.java

/*******************************************************************************\r
 * Copyright (c) 2009 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Alvaro Sanchez-Leon (alvsan09@gmail.com) - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.lttng.ui.model.trange;\r
\r
import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITmfTimeAnalysisEntry;\r
\r
/**\r
 * @author alvaro\r
 * \r
 */\r
public class TimeRangeEvent extends TimeRangeComponent implements ITimeEvent {\r
	// =======================================================================\r
	// Data\r
	// =======================================================================\r
	TimeRangeComposite parent = null;\r
\r
	public static enum Type {\r
		UNKNOWN, PROPERTY, PROCESS_MODE, BDEV_MODE, TRAP_MODE, SOFT_IRQ_MODE, IRQ_MODE, CPU_MODE\r
	}\r
\r
	protected Type eventType = Type.UNKNOWN;\r
	protected String stateMode = ""; //$NON-NLS-1$\r
\r
	// =======================================================================\r
	// Constructors\r
	// =======================================================================\r
	/**\r
	 * @param stime\r
	 *            Event Start Time (may be unknown)\r
	 * @param etime\r
	 *            Event EndTime (may be unknown)\r
	 * @param eventParent\r
	 * @param type\r
	 * @param duration\r
	 */\r
	public TimeRangeEvent(Long stime, Long etime,\r
			TimeRangeComposite eventParent, Type type, String stateMode) {\r
		super(stime, etime, eventParent);\r
\r
		this.eventType = type;\r
		this.stateMode = stateMode;\r
	}\r
\r
	// =======================================================================\r
	// Methods\r
	// =======================================================================\r
	\r
	// @Override\r
	/*\r
	 * (non-Javadoc)\r
	 * \r
	 * @see\r
	 * org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent#getTime\r
	 * ()\r
	 */\r
	@Override\r
	public long getTime() {\r
		// The value provided by this method is used to start drawing the\r
		// time-range,\r
		// so a null value shall not be provided.\r
		// If the actual start time is unknown then use the start of the Trace\r
		// as the\r
		// starting reference point.\r
		if (startTime == null) {\r
			return eventParent.getStartTime();\r
		}\r
		return startTime;\r
	}\r
\r
	/*\r
	 * (non-Javadoc)\r
	 * \r
	 * @see\r
	 * org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent#getEntry\r
	 * ()\r
	 */\r
	@Override\r
	public ITmfTimeAnalysisEntry getEntry() {\r
		return parent;\r
	}\r
\r
	/**\r
	 * return the duration between end and start time , if the start time or end\r
	 * time are unknown, use the Trace start and End times to estimate it, this\r
	 * value will be used to draw the time range and need to provide a valid\r
	 * time width.\r
	 * \r
	 * @return the duration\r
	 */\r
	/*\r
	 * (non-Javadoc)\r
	 * \r
	 * @seeorg.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent#\r
	 * getDuration()\r
	 */\r
	@Override\r
	public long getDuration() {\r
		long duration = -1;\r
		long endT = (stopTime == null) ? parent.getStopTime() : stopTime;\r
		long startT = (startTime == null) ? parent.getStartTime() : startTime;\r
\r
		if (endT > startT) {\r
			return stopTime - startTime;\r
		}\r
		return duration;\r
	}\r
\r
	/**\r
	 * @return\r
	 */\r
	public String getStateMode() {\r
		return stateMode;\r
	}\r
\r
	/**\r
	 * @param stateMode\r
	 */\r
	public void setStateMode(String stateMode) {\r
		if (stateMode != null) {\r
			this.stateMode = stateMode;\r
		}\r
	}\r
\r
	/*\r
	 * (non-Javadoc)\r
	 * \r
	 * @see org.eclipse.linuxtools.lttng.ui.model.ITimeRangeComponent#getName()\r
	 */\r
	@Override\r
	public String getName() {\r
		return stateMode;\r
	}\r
\r
	/**\r
	 * @return\r
	 */\r
	public Type getEventType() {\r
		return eventType;\r
	}\r
\r
	/**\r
	 * @param eventType\r
	 */\r
	public void setEventType(Type eventType) {\r
		this.eventType = eventType;\r
	}\r
\r
}\r