aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarc-Andre Laperle2013-05-29 18:10:13 (EDT)
committerBernd Hufmann2013-06-03 12:52:32 (EDT)
commitaea9bfe1fffe8f6a4efeae3427f0078f12e69a69 (patch)
treef7e3d0fb28a1a8a9f6e0260240a8d92e5a43ea6d
parent23ca29a2fdbd533b89e84d8b6e1b0af08a2e4b37 (diff)
downloadorg.eclipse.linuxtools-aea9bfe1fffe8f6a4efeae3427f0078f12e69a69.zip
org.eclipse.linuxtools-aea9bfe1fffe8f6a4efeae3427f0078f12e69a69.tar.gz
org.eclipse.linuxtools-aea9bfe1fffe8f6a4efeae3427f0078f12e69a69.tar.bz2
Add a View guide to the TMF documentation
cherry-picked from 1b3bb112d28d65289cc7ae527a4774e5c328bb37 Change-Id: I7a99a17a3b87babd7c6bc413e54daabfa77bc869 Signed-off-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com> Reviewed-on: https://git.eclipse.org/r/13374 Tested-by: Hudson CI Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com> IP-Clean: Bernd Hufmann <bernd.hufmann@ericsson.com> Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
-rw-r--r--lttng/org.eclipse.linuxtools.tmf.help/doc/User-Guide.mediawiki345
-rw-r--r--lttng/org.eclipse.linuxtools.tmf.help/doc/images/EmptySampleView.pngbin0 -> 17413 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.tmf.help/doc/images/FillSampleViewExtension.pngbin0 -> 27277 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.tmf.help/doc/images/SampleView.pngbin0 -> 13557 bytes
4 files changed, 343 insertions, 2 deletions
diff --git a/lttng/org.eclipse.linuxtools.tmf.help/doc/User-Guide.mediawiki b/lttng/org.eclipse.linuxtools.tmf.help/doc/User-Guide.mediawiki
index c364839..f943b64 100644
--- a/lttng/org.eclipse.linuxtools.tmf.help/doc/User-Guide.mediawiki
+++ b/lttng/org.eclipse.linuxtools.tmf.help/doc/User-Guide.mediawiki
@@ -126,7 +126,7 @@ To create a new project with name org.eclipse.linuxtools.tmf.sample.ui select ''
[[Image:images/Screenshot-NewPlug-inProject2.png]]<br>
-[[Image:Screenshot-NewPlug-inProject3.png]]<br>
+[[Image:images/Screenshot-NewPlug-inProject3.png]]<br>
=== Creating a Sequence Diagram View ===
@@ -952,6 +952,348 @@ In some case it might be necessary to change the implementation of the analysis
=== Downloading the Reference Plug-in ===
To download the reference plug-in that demonstrates the reference loader, use the following link: [http://wiki.eclipse.org/images/d/d3/ReferencePlugin.zip Reference Plug-in]. Just extract the zip file and import the extracted Eclipse plug-in (plug-in name: ''org.eclipse.linuxtools.tmf.reference.ui'') to your Eclipse workspace. <br>
+= View Tutorial =
+
+This tutorial describes how to create a simple view using the TMF framework and the SWTChart library. SWTChart is a library based on SWT that can draw several types of charts including a line chart which we will use in this tutorial. We will create a view containing a line chart that displays time stamps on the X axis and the corresponding event values on the Y axis.
+
+This tutorial will cover concepts like:
+
+* Extending TmfView
+* Signal handling (@TmfSignalHandler)
+* Data requests (TmfEventRequest)
+* SWTChart integration
+
+=== Prerequisites ===
+
+The tutorial is based on Eclipse 4.3 (Eclipse Kepler), TMF 2.0.0 and SWTChart 0.7.0. You can install SWTChart by using the Orbit update site. http://download.eclipse.org/tools/orbit/downloads/
+
+=== Creating an Eclipse UI Plug-in ===
+
+To create a new project with name org.eclipse.linuxtools.tmf.sample.ui select '''File -> New -> Project -> Plug-in Development -> Plug-in Project'''. <br>
+[[Image:images/Screenshot-NewPlug-inProject1.png]]<br>
+
+[[Image:images/Screenshot-NewPlug-inProject2.png]]<br>
+
+[[Image:images/Screenshot-NewPlug-inProject3.png]]<br>
+
+=== Creating a View ===
+
+To open the plug-in manifest, double-click on the MANIFEST.MF file. <br>
+[[Image:images/SelectManifest.png]]<br>
+
+Change to the Dependencies tab and select '''Add...''' of the ''Required Plug-ins'' section. A new dialog box will open. Next find plug-in ''org.eclipse.linuxtools.tmf.core'' and press '''OK'''<br>
+Following the same steps, add ''org.eclipse.linuxtools.tmf.ui'' and ''org.swtchart''.<br>
+[[Image:images/AddDependencyTmfUi.png]]<br>
+
+Change to the Extensions tab and select '''Add...''' of the ''All Extension'' section. A new dialog box will open. Find the view extension ''org.eclipse.ui.views'' and press '''Finish'''.<br>
+[[Image:images/AddViewExtension1.png]]<br>
+
+To create a view, click the right mouse button. Then select '''New -> view'''<br>
+[[Image:images/AddViewExtension2.png]]<br>
+
+A new view entry has been created. Fill in the fields ''id'' and ''name''. For ''class'' click on the '''class hyperlink''' and it will show the New Java Class dialog. Enter the name ''SampleView'', change the superclass to ''TmfView'' and click Finish. This will create the source file and fill the ''class'' field in the process. We use TmfView as the superclass because it provides extra functionality like getting the active trace, pinning and it has support for signal handling between components.<br>
+[[Image:images/FillSampleViewExtension.png]]<br>
+
+This will generate an empty class. Once the quick fixes are applied, the following code is obtained:
+
+<pre>
+package org.eclipse.linuxtools.tmf.sample.ui;
+
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.ui.part.ViewPart;
+
+public class SampleView extends TmfView {
+
+ public SampleView(String viewName) {
+ super(viewName);
+ // TODO Auto-generated constructor stub
+ }
+
+ @Override
+ public void createPartControl(Composite parent) {
+ // TODO Auto-generated method stub
+
+ }
+
+ @Override
+ public void setFocus() {
+ // TODO Auto-generated method stub
+
+ }
+
+}
+</pre>
+
+This creates an empty view, however the basic structure is now is place.
+
+===Implementing a view===
+
+We will start by adding a empty chart then it will need to be populated with the trace data. Finally, we will make the chart more visually pleasing by adjusting the range and formating the time stamps.
+
+====Adding an Empty Chart====
+
+First, we can add an empty chart to the view and initialize some of its components.
+
+<pre>
+ private static final String SERIES_NAME = "Series";
+ private static final String Y_AXIS_TITLE = "Signal";
+ private static final String X_AXIS_TITLE = "Time";
+ private static final String FIELD = "value"; // The name of the field that we want to display on the Y axis
+ private static final String VIEW_ID = "org.eclipse.linuxtools.tmf.sample.ui.view";
+ private Chart chart;
+ private ITmfTrace currentTrace;
+
+ public SampleView() {
+ super(VIEW_ID);
+ }
+
+ @Override
+ public void createPartControl(Composite parent) {
+ chart = new Chart(parent, SWT.BORDER);
+ chart.getTitle().setVisible(false);
+ chart.getAxisSet().getXAxis(0).getTitle().setText(X_AXIS_TITLE);
+ chart.getAxisSet().getYAxis(0).getTitle().setText(Y_AXIS_TITLE);
+ chart.getSeriesSet().createSeries(SeriesType.LINE, SERIES_NAME);
+ chart.getLegend().setVisible(false);
+ }
+
+ @Override
+ public void setFocus() {
+ chart.setFocus();
+ }
+</pre>
+
+The view is prepared. Run the Example. To launch the an Eclipse Application select the ''Overview'' tab and click on '''Launch an Eclipse Application'''<br>
+[[Image:images/RunEclipseApplication.png]]<br>
+
+A new Eclipse application window will show. In the new window go to '''Windows -> Show View -> Other... -> Other -> Sample View'''.<br>
+[[Image:images/ShowViewOther.png]]<br>
+
+You should now see a view containing an empty chart<br>
+[[Image:images/EmptySampleView.png]]<br>
+
+====Signal Handling====
+
+We would like to populate the view when a trace is selected. To achieve this, we can use a signal hander which is specified with the '''@TmfSignalHandler''' annotation.
+
+<pre>
+ @TmfSignalHandler
+ public void traceSelected(final TmfTraceSelectedSignal signal) {
+
+ }
+</pre>
+
+====Requesting Data====
+
+Then we need to actually gather data from the trace. This is done asynchronously using a ''TmfEventRequest''
+
+<pre>
+ @TmfSignalHandler
+ public void traceSelected(final TmfTraceSelectedSignal signal) {
+ // Don't populate the view again if we're already showing this trace
+ if (currentTrace == signal.getTrace()) {
+ return;
+ }
+ currentTrace = signal.getTrace();
+
+ // Create the request to get data from the trace
+
+ TmfEventRequest req = new TmfEventRequest(TmfEvent.class,
+ TmfTimeRange.ETERNITY, TmfEventRequest.ALL_DATA,
+ ExecutionType.BACKGROUND) {
+
+ @Override
+ public void handleData(ITmfEvent data) {
+ // Called for each event
+ super.handleData(data);
+ }
+
+ @Override
+ public void handleSuccess() {
+ // Request successful, not more data available
+ super.handleSuccess();
+ }
+
+ @Override
+ public void handleFailure() {
+ // Request failed, not more data available
+ super.handleFailure();
+ }
+ };
+ ITmfTrace trace = signal.getTrace();
+ trace.sendRequest(req);
+ }
+</pre>
+
+====Transferring Data to the Chart====
+
+The chart expects an array of doubles for both the X and Y axis values. To provide that, we can accumulate each event's time and value in their respective list then convert the list to arrays when all events are processed.
+
+<pre>
+ TmfEventRequest req = new TmfEventRequest(TmfEvent.class,
+ TmfTimeRange.ETERNITY, TmfEventRequest.ALL_DATA,
+ ExecutionType.BACKGROUND) {
+
+ ArrayList<Double> xValues = new ArrayList<Double>();
+ ArrayList<Double> yValues = new ArrayList<Double>();
+
+ @Override
+ public void handleData(ITmfEvent data) {
+ // Called for each event
+ super.handleData(data);
+ ITmfEventField field = data.getContent().getField(FIELD);
+ if (field != null) {
+ yValues.add((Double) field.getValue());
+ xValues.add((double) data.getTimestamp().getValue());
+ }
+ }
+
+ @Override
+ public void handleSuccess() {
+ // Request successful, not more data available
+ super.handleSuccess();
+
+ final double x[] = toArray(xValues);
+ final double y[] = toArray(yValues);
+
+ // This part needs to run on the UI thread since it updates the chart SWT control
+ Display.getDefault().asyncExec(new Runnable() {
+
+ @Override
+ public void run() {
+ chart.getSeriesSet().getSeries()[0].setXSeries(x);
+ chart.getSeriesSet().getSeries()[0].setYSeries(y);
+
+ chart.redraw();
+ }
+
+ });
+ }
+
+ /**
+ * Convert List<Double> to double[]
+ */
+ private double[] toArray(List<Double> list) {
+ double[] d = new double[list.size()];
+ for (int i = 0; i < list.size(); ++i) {
+ d[i] = list.get(i);
+ }
+
+ return d;
+ }
+ };
+</pre>
+
+====Adjusting the Range====
+
+The chart now contains values but they might be out of range and not visible. We can adjust the range of each axis by computing the minimum and maximum values as we add events.
+
+<pre>
+
+ ArrayList<Double> xValues = new ArrayList<Double>();
+ ArrayList<Double> yValues = new ArrayList<Double>();
+ private double maxY = -Double.MAX_VALUE;
+ private double minY = Double.MAX_VALUE;
+ private double maxX = -Double.MAX_VALUE;
+ private double minX = Double.MAX_VALUE;
+
+ @Override
+ public void handleData(ITmfEvent data) {
+ super.handleData(data);
+ ITmfEventField field = data.getContent().getField(FIELD);
+ if (field != null) {
+ Double yValue = (Double) field.getValue();
+ minY = Math.min(minY, yValue);
+ maxY = Math.max(maxY, yValue);
+ yValues.add(yValue);
+
+ double xValue = (double) data.getTimestamp().getValue();
+ xValues.add(xValue);
+ minX = Math.min(minX, xValue);
+ maxX = Math.max(maxX, xValue);
+ }
+ }
+
+ @Override
+ public void handleSuccess() {
+ super.handleSuccess();
+ final double x[] = toArray(xValues);
+ final double y[] = toArray(yValues);
+
+ // This part needs to run on the UI thread since it updates the chart SWT control
+ Display.getDefault().asyncExec(new Runnable() {
+
+ @Override
+ public void run() {
+ chart.getSeriesSet().getSeries()[0].setXSeries(x);
+ chart.getSeriesSet().getSeries()[0].setYSeries(y);
+
+ // Set the new range
+ if (!xValues.isEmpty() && !yValues.isEmpty()) {
+ chart.getAxisSet().getXAxis(0).setRange(new Range(0, x[x.length - 1]));
+ chart.getAxisSet().getYAxis(0).setRange(new Range(minY, maxY));
+ } else {
+ chart.getAxisSet().getXAxis(0).setRange(new Range(0, 1));
+ chart.getAxisSet().getYAxis(0).setRange(new Range(0, 1));
+ }
+ chart.getAxisSet().adjustRange();
+
+ chart.redraw();
+ }
+ });
+ }
+</pre>
+
+====Formatting the Time Stamps====
+
+To display the time stamps on the X axis nicely, we need to specify a format or else the time stamps will be displayed as ''long''. We use TmfTimestampFormat to make it consistent with the other TMF views. We also need to handle the '''TmfTimestampFormatUpdateSignal''' to make sure that the time stamps update when the preferences change.
+
+<pre>
+ @Override
+ public void createPartControl(Composite parent) {
+ ...
+
+ chart.getAxisSet().getXAxis(0).getTick().setFormat(new TmfChartTimeStampFormat());
+ }
+
+ public class TmfChartTimeStampFormat extends SimpleDateFormat {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) {
+ long time = date.getTime();
+ toAppendTo.append(TmfTimestampFormat.getDefaulTimeFormat().format(time));
+ return toAppendTo;
+ }
+ }
+
+ @TmfSignalHandler
+ public void timestampFormatUpdated(TmfTimestampFormatUpdateSignal signal) {
+ // Called when the time stamp preference is changed
+ chart.getAxisSet().getXAxis(0).getTick().setFormat(new TmfChartTimeStampFormat());
+ chart.redraw();
+ }
+</pre>
+
+We also need to populate the view when a trace is already selected and the view is opened. We can reuse the same code by having the view send the '''TmfTraceSelectedSignal''' to itself.
+
+<pre>
+ @Override
+ public void createPartControl(Composite parent) {
+ ...
+
+ ITmfTrace trace = getActiveTrace();
+ if (trace != null) {
+ traceSelected(new TmfTraceSelectedSignal(this, trace));
+ }
+ }
+</pre>
+
+The view is now ready but we need a proper trace to test it. For this example, a trace was generated using LTTng-UST so that it would produce a sine function.<br>
+
+[[Image:images/SampleView.png]]<br>
+
+In summary, we have implemented a simple TMF view using the SWTChart library. We made use of signals and requests to populate the view at the appropriate time and we formated the time stamps nicely. We also made sure that the time stamp format is updated when the preferences change.
+
=CTF Parser=
== CTF Format ==
@@ -1024,4 +1366,3 @@ There are other helper files that format given events for views, they are simple
=== Limitations ===
For the moment live trace reading is not supported, there are no sources of traces to test on.
-
diff --git a/lttng/org.eclipse.linuxtools.tmf.help/doc/images/EmptySampleView.png b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/EmptySampleView.png
new file mode 100644
index 0000000..13ace64
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/EmptySampleView.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.tmf.help/doc/images/FillSampleViewExtension.png b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/FillSampleViewExtension.png
new file mode 100644
index 0000000..e14b8bb
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/FillSampleViewExtension.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.tmf.help/doc/images/SampleView.png b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/SampleView.png
new file mode 100644
index 0000000..0b3477a
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.tmf.help/doc/images/SampleView.png
Binary files differ