blob: 6c3ccd0b77e223c1c23950bb727afdb7f27d135f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.linuxtools.tmf.core" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
<appinfo>
<meta.schema plugin="org.eclipse.linuxtools.tmf.core" id="tracetype" name="TMF Trace Type"/>
</appinfo>
<documentation>
This extension point is used to contribute new trace types or experiment types to the generic components of the TMF framework.
</documentation>
</annotation>
<element name="extension">
<annotation>
<appinfo>
<meta.element />
</appinfo>
</annotation>
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="category"/>
<element ref="type"/>
<element ref="experiment"/>
</choice>
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
a fully qualified identifier of the target extension point
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
an optional identifier of the extension instance
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
an optional name of the extension instance
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
</complexType>
</element>
<element name="category">
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
a unique name that will be used to identify this category
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string" use="required">
<annotation>
<documentation>
a translatable name that will be used in the UI for this category
</documentation>
</annotation>
</attribute>
</complexType>
</element>
<element name="type">
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
The unique ID that identifies this trace type.
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string" use="required">
<annotation>
<documentation>
The type name as it is displayed to the end user.
</documentation>
</annotation>
</attribute>
<attribute name="category" type="string">
<annotation>
<documentation>
An optional attribute that is composed of the category ID. The referenced category must be declared in a corresponding category element.
</documentation>
<appinfo>
<meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/category/@id"/>
</appinfo>
</annotation>
</attribute>
<attribute name="trace_type" type="string" use="required">
<annotation>
<documentation>
The fully qualified name of a class that implements the <samp>ITmfTrace</samp> interface.
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn=":org.eclipse.tracecompass.tmf.core.trace.ITmfTrace"/>
</appinfo>
</annotation>
</attribute>
<attribute name="event_type" type="string" use="required">
<annotation>
<documentation>
The fully qualified name of a class that implements the <samp>ITmfEvent</samp> interface
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn=":org.eclipse.tracecompass.tmf.core.event.ITmfEvent"/>
</appinfo>
</annotation>
</attribute>
<attribute name="isDirectory" type="boolean" use="default" value="false">
<annotation>
<documentation>
Indicates whether the trace type is for traces that are directories (true) or files (false)
</documentation>
</annotation>
</attribute>
</complexType>
</element>
<element name="experiment">
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
The unique ID that identifies this experiment type.
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string" use="required">
<annotation>
<documentation>
The type name as it is displayed to the end user.
</documentation>
</annotation>
</attribute>
<attribute name="category" type="string">
<annotation>
<documentation>
An optional attribute that is composed of the category ID. The referenced category must be declared in a corresponding category element.
</documentation>
<appinfo>
<meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/category/@id"/>
</appinfo>
</annotation>
</attribute>
<attribute name="experiment_type" type="string" use="required">
<annotation>
<documentation>
The fully qualified name of a class that extends the <samp>TmfExperiment</samp> class
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn="org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment:"/>
</appinfo>
</annotation>
</attribute>
</complexType>
</element>
<annotation>
<appinfo>
<meta.section type="since"/>
</appinfo>
<documentation>
3.0
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="examples"/>
</appinfo>
<documentation>
Example use of the tmftracetype extension point for generic CTF traces (CtfTmfTrace) and a category-less generic experiment type:
<extension
point="org.eclipse.linuxtools.tmf.core.tracetype">
<category
id="org.eclipse.linuxtools.tmf.core.category.ctf"
name="Common Trace Format">
</category>
<type
category="org.eclipse.linuxtools.tmf.core.category.ctf"
event_type="org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfEvent"
id="org.eclipse.linuxtools.tmf.core.type.ctf"
name="Generic CTF Trace"
trace_type="org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTrace">
</type>
<experiment
id="org.eclipse.linuxtools.tmf.core.experiment.generic"
name="Generic experiment"
experiment_type="org.eclipse.linuxtools.tmf.core.trace.TmfExperiment">
</experiment>
</extension>
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="apiinfo"/>
</appinfo>
<documentation>
Trace types using this extension point have to specify the two following classes:
* trace_type: Has to implement ITmfTrace. It's *highly* recommend to extend 'TmfTrace' to get default implementations.
* event_type: Has to implement ITmfEvent. Once again, TmfEvent provides a reference implementation that should work in most cases.
Experiment types using this extension point have to specify the following class:
* experiment_type: Has to extend TmfExperiment. This class is the default experiment class, to be used to analyse sets of traces, where each trace is treated equally.
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="copyright"/>
</appinfo>
<documentation>
Copyright (c) 2014 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
</documentation>
</annotation>
</schema>
|
