/*******************************************************************************
- * Copyright (c) 2009, 2011, 2012 Ericsson
- *
+ * Copyright (c) 2009, 2013 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
* Francois Chouinard - Updated as per TMF Trace Model 1.0
package org.eclipse.linuxtools.tmf.core.trace;
+import java.util.Collections;
+import java.util.Map;
+
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.IStatus;
import org.eclipse.linuxtools.tmf.core.component.ITmfDataProvider;
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
+import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateSystem;
+import org.eclipse.linuxtools.tmf.core.statistics.ITmfStatistics;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
/**
* The event stream structure in TMF. In its basic form, a trace has:
* </ul>
* Concrete ITmfTrace classes have to provide a parameter-less constructor and
* an initialization method (<i>initTrace</i>) if they are to be opened from
- * the Project View. Also, a validation method (<i>validate</i>) has to be
+ * the Project View. Also, a validation method (<i>validate</i>) has to be
* provided to ensure that the trace is of the correct type.
* <p>
* A trace can be accessed simultaneously from multiple threads by various
* super.handleCompleted();
* }
* };
- *
+ *
* fTrace.handleRequest(request);
* if (youWant) {
* request.waitForCompletion();
- * }
+ * }
* </pre>
- *
+ *
* @version 1.0
* @author Francois Chouinard
- *
+ *
* @see ITmfContext
* @see ITmfEvent
* @see ITmfTraceIndexer
* @see ITmfEventParser
*/
-public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
+public interface ITmfTrace extends ITmfDataProvider {
// ------------------------------------------------------------------------
// Constants
* <p>
* Typically, the parameterless constructor will provide the block size
* and its associated parser and indexer.
- *
+ *
* @param resource the trace resource
* @param path the trace path
* @param type the trace event type
- * @throws TmfTraceException
+ * @throws TmfTraceException If we couldn't open the trace
*/
- public void initTrace(IResource resource, String path, Class<T> type) throws TmfTraceException;
+ public void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
/**
* Validate that the trace is of the correct type.
- *
+ *
* @param project the eclipse project
* @param path the trace path
- *
+ *
* @return true if trace is valid
+ * @since 2.0
*/
- public boolean validate(IProject project, String path);
+ public IStatus validate(IProject project, String path);
// ------------------------------------------------------------------------
// Basic getters
// ------------------------------------------------------------------------
+ /**
+ * If this trace is used as a container for sub-traces, this can be used to
+ * get the sub-traces themselves. If the trace is stand-alone, this should
+ * return an array with only "this" inside. For this reason, be careful if
+ * calling this recursively.
+ *
+ * This offers a standard way of iterating through compound traces (like
+ * experiments).
+ *
+ * @return The array of sub-traces.
+ * @since 2.0
+ */
+ public ITmfTrace[] getTraces();
+
/**
* @return the trace event type
*/
- public Class<T> getEventType();
+ public Class<? extends ITmfEvent> getEventType();
/**
* @return the associated trace resource
*/
public int getCacheSize();
+ /**
+ * @return The statistics provider for this trace
+ * @since 2.0
+ */
+ public ITmfStatistics getStatistics();
+
+ /**
+ * Return the map of state systems associated with this trace.
+ *
+ * This view should be read-only (implementations should use
+ * {@link Collections#unmodifiableMap}).
+ *
+ * @return The map of state systems
+ * @since 2.0
+ */
+ public Map<String, ITmfStateSystem> getStateSystems();
+
+ /**
+ * If a state system is not build by the trace itself, it's possible to
+ * register it if it comes from another source. It will then be accessible
+ * with {@link #getStateSystems} normally.
+ *
+ * @param id
+ * The unique ID to assign to this state system. In case of
+ * conflicting ID's, the new one will overwrite the previous one
+ * (default Map behavior).
+ * @param ss
+ * The already-built state system
+ * @since 2.0
+ */
+ public void registerStateSystem(String id, ITmfStateSystem ss);
+
// ------------------------------------------------------------------------
// Trace characteristics getters
// ------------------------------------------------------------------------
/**
* @return the trace time range
+ * @since 2.0
*/
public TmfTimeRange getTimeRange();
/**
* @return the timestamp of the first trace event
+ * @since 2.0
*/
public ITmfTimestamp getStartTime();
/**
* @return the timestamp of the last trace event
+ * @since 2.0
*/
public ITmfTimestamp getEndTime();
/**
* @return the current trace location
*/
- public ITmfLocation<?> getCurrentLocation();
+ public ITmfLocation getCurrentLocation();
/**
* Returns the ratio (proportion) corresponding to the specified location.
- *
+ *
* @param location a trace specific location
* @return a floating-point number between 0.0 (beginning) and 1.0 (end)
*/
- public double getLocationRatio(ITmfLocation<?> location);
+ public double getLocationRatio(ITmfLocation location);
// ------------------------------------------------------------------------
// SeekEvent operations (returning a trace context)
* @param location the trace specific location
* @return a context which can later be used to read the corresponding event
*/
- public ITmfContext seekEvent(ITmfLocation<?> location);
+ public ITmfContext seekEvent(ITmfLocation location);
/**
* Position the trace at the 'rank'th event in the trace.
* <p>
* If the requested rank is beyond the last trace event, the context
* returned will yield a null event if used in a subsequent read.
- *
+ *
* @param rank the event rank
* @return a context which can later be used to read the corresponding event
*/
* <p>
* If the requested timestamp is beyond the last trace event, the context
* returned will yield a null event if used in a subsequent read.
- *
+ *
* @param timestamp the timestamp of desired event
* @return a context which can later be used to read the corresponding event
+ * @since 2.0
*/
public ITmfContext seekEvent(ITmfTimestamp timestamp);
* The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
* voluntarily vague. Typically, it would refer to the event proportional
* rank (arguably more intuitive) or timestamp in the trace file.
- *
+ *
* @param ratio the proportional 'rank' in the trace
* @return a context which can later be used to read the corresponding event
*/
public ITmfContext seekEvent(double ratio);
+ /**
+ * Returns the initial range offset
+ *
+ * @return the initial range offset
+ * @since 2.0
+ */
+ public ITmfTimestamp getInitialRangeOffset();
+
+ /**
+ * Return the current selected time.
+ *
+ * @return the current time stamp
+ * @since 2.0
+ */
+ public ITmfTimestamp getCurrentTime();
+
+ /**
+ * Return the current selected range.
+ *
+ * @return the current time range
+ * @since 2.0
+ */
+ public TmfTimeRange getCurrentRange();
}
projects / deliverable / tracecompass.git / blobdiff