1 <?xml version='1.0' encoding='UTF-8'?>
2 <!-- Schema file written by PDE -->
3 <schema targetNamespace="org.eclipse.linuxtools.tmf.core" xmlns="http://www.w3.org/2001/XMLSchema">
6 <meta.schema plugin="org.eclipse.linuxtools.tmf.core" id="org.eclipse.linuxtools.tmf.core.analysis" name="Trace Analysis Module"/>
9 This extension point is used to contribute new analysis modules to the TMF framework. Analysis modules provide new independent functionalities that can be run on traces.
13 <element name="extension">
20 <sequence minOccurs="0" maxOccurs="unbounded">
21 <element ref="module"/>
22 <element ref="source"/>
24 <attribute name="point" type="string" use="required">
27 a fully qualified identifier of the target extension point
31 <attribute name="id" type="string">
34 an optional identifier of the extension instance
38 <attribute name="name" type="string">
41 an optional name of the extension instance
44 <meta.attribute translatable="true"/>
51 <element name="module">
53 <sequence minOccurs="0" maxOccurs="unbounded">
54 <element ref="parameter"/>
55 <element ref="tracetype"/>
57 <attribute name="id" type="string" use="required">
60 The unique ID that identifies this analysis module.
64 <attribute name="name" type="string" use="required">
67 The trace analysis module's name as it is displayed to the end user
71 <attribute name="analysis_module" type="string" use="required">
74 The fully qualified name of a class that implements the <samp>IAnalysisModule</samp> interface.
77 <meta.attribute kind="java" basedOn=":org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule"/>
81 <attribute name="icon" type="string">
84 The icon associated to this analysis module.
87 <meta.attribute kind="resource"/>
91 <attribute name="automatic" type="boolean">
94 Whether to execute this analysis automatically when trace is opened, or wait for the user to ask for it
101 <element name="parameter">
104 Parameter for this module
108 <attribute name="name" type="string" use="required">
115 <attribute name="default_value" type="string">
118 A default value for this parameter
125 <element name="tracetype">
128 Allow to define the tracetypes this analysis applies to.
132 <attribute name="class" type="string" use="required">
135 The base trace class this analysis applies to or not (it also applies to traces extending this class).
138 <meta.attribute kind="java" basedOn=":org.eclipse.linuxtools.tmf.core.trace.ITmfTrace"/>
142 <attribute name="applies" type="boolean">
145 Does this tracetype element mean the class applies or not (default true)
152 <element name="source">
155 Specifies a class that provides analysis modules.
159 <attribute name="class" type="string" use="required">
162 The fully qualified name of a class that implements the <samp>IAnalysisModuleSource</samp> interface.
165 <meta.attribute kind="java" basedOn=":org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModuleSource"/>
174 <meta.section type="since"/>
183 <meta.section type="examples"/>
187 For an example implementation of an analysis module see:
189 plug-in: org.eclipse.linuxtools.tmf.core.tests
190 package: org.eclipse.linuxtools.tmf.core.tests.stubs.analysis
191 class: TestCtfAnalysis
196 The following is an example of the extension point:
199 point="org.eclipse.linuxtools.tmf.core.analysis">
201 id="org.eclipse.linuxtools.tmf.core.tests.analysis.testctf"
202 name="Test analysis ctf"
203 analysis_module="org.eclipse.linuxtools.tmf.tests.stubs.analysis.TestCtfAnalysis"
204 automatic="true">
214 <meta.section type="apiinfo"/>
218 For this extension point, a class implementing IAnalysisModule must be defined (org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule). Most analysis can just extend the org.eclipse.linuxtools.tmf.core.analysis.TmfAbstractAnalysisModule class, since it already contains everything to manage the trace's, the analysis' execution, cancellation, completion, the help texts, etc.
221 The key method to implement if extending TmfAbstractAnalysisModule is executeAnalysis(final IProgressMonitor monitor). It contains the code of the analysis itself and is executed inside an Eclipse job.
229 <meta.section type="copyright"/>
232 Copyright (c) 2013 École Polytechnique de Montréal
234 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>