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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_12) on Sat Jul 21 23:05:57 CEST 2007 -->
<TITLE>
Tool
</TITLE>
<META NAME="keywords" CONTENT="org.sump.analyzer.tools.Tool interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Tool";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Tool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/sump/analyzer/tools/StateAnalysis.html" title="class in org.sump.analyzer.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/sump/analyzer/tools/Tool.html" target="_top"><B>FRAMES</B></A>
<A HREF="Tool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.sump.analyzer.tools</FONT>
<BR>
Interface Tool</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/sump/analyzer/tools/Base.html" title="class in org.sump.analyzer.tools">Base</A>, <A HREF="../../../../org/sump/analyzer/tools/I2CProtocolAnalysis.html" title="class in org.sump.analyzer.tools">I2CProtocolAnalysis</A>, <A HREF="../../../../org/sump/analyzer/tools/SPIProtocolAnalysis.html" title="class in org.sump.analyzer.tools">SPIProtocolAnalysis</A>, <A HREF="../../../../org/sump/analyzer/tools/StateAnalysis.html" title="class in org.sump.analyzer.tools">StateAnalysis</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Tool</B></DL>
</PRE>
<P>
Interface for pluggable tools.
<p>
All tools implementing this interface that are added to the tools class list
will be automatically added to the tools menu in the client.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>0.7</DD>
<DT><B>Author:</B></DT>
<DD>Michael "Mr. Sump" Poppitz</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/sump/analyzer/tools/Tool.html#getName()">getName</A></B>()</CODE>
<BR>
Is called to get the name for the menu entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/sump/analyzer/tools/Tool.html#init(java.awt.Frame)">init</A></B>(java.awt.Frame frame)</CODE>
<BR>
Performs tool initialization.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/sump/analyzer/tools/Tool.html#process(org.sump.analyzer.CapturedData)">process</A></B>(<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> data)</CODE>
<BR>
This method is invoked when the tool is selected from the Tools menu.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/sump/analyzer/tools/Tool.html#process(org.sump.analyzer.CapturedData, int, int, int)">process</A></B>(<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> data,
int group,
int channel,
int position)</CODE>
<BR>
This method is invoked when the tool is selected from the context menu after right clicking someplace in the diagram.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Is called to get the name for the menu entry.
The name must be unique among all tools. Should end in "..." if it opens a dialog window.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>name for this tool</DL>
</DD>
</DL>
<HR>
<A NAME="init(java.awt.Frame)"><!-- --></A><H3>
init</H3>
<PRE>
void <B>init</B>(java.awt.Frame frame)</PRE>
<DL>
<DD>Performs tool initialization.
This method should also prepare the dialog, if one is needed
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>frame</CODE> - main window's frame (needed for modal dialogs)</DL>
</DD>
</DL>
<HR>
<A NAME="process(org.sump.analyzer.CapturedData)"><!-- --></A><H3>
process</H3>
<PRE>
<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> <B>process</B>(<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> data)</PRE>
<DL>
<DD>This method is invoked when the tool is selected from the Tools menu.
It should request any missing information using a dialog and perform the tool's actual task.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - currently displayed captured data
<DT><B>Returns:</B><DD>new <code>CapturedData</code> if provided data has been altered or <code>null</code> otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="process(org.sump.analyzer.CapturedData, int, int, int)"><!-- --></A><H3>
process</H3>
<PRE>
<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> <B>process</B>(<A HREF="../../../../org/sump/analyzer/CapturedData.html" title="class in org.sump.analyzer">CapturedData</A> data,
int group,
int channel,
int position)</PRE>
<DL>
<DD>This method is invoked when the tool is selected from the context menu after right clicking someplace in the diagram.
It should request any missing information using a dialog and perform the tool's actual task.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - currently displayed captured data<DD><CODE>group</CODE> - channel group at the mouse position where the menu was openend<DD><CODE>channel</CODE> - number of channel at the mouse position where the menu was openend<DD><CODE>position</CODE> - number of sample at the mouse position where the menu was openend
<DT><B>Returns:</B><DD>new <code>CapturedData</code> if provided data has been altered or <code>null</code> otherwise</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Tool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/sump/analyzer/tools/StateAnalysis.html" title="class in org.sump.analyzer.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/sump/analyzer/tools/Tool.html" target="_top"><B>FRAMES</B></A>
<A HREF="Tool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
