1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:30 CET 2009 -->
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.util.Timer class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="Timer (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
26 <!-- ========= START OF TOP NAVBAR ======= -->
\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
34 <TR ALIGN="center" VALIGN="top">
\r
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/util/Utilities.html" title="class in com.sun.speech.freetts.util"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="Timer.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts.util</FONT>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.util.Timer</B>
\r
93 <DT>public class <B>Timer</B><DT>extends java.lang.Object</DL>
\r
96 Keeps track of execution times.
\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
106 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
111 <A NAME="constructor_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
114 <TD COLSPAN=2><FONT SIZE="+2">
\r
115 <B>Constructor Summary</B></FONT></TD>
\r
117 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
118 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#Timer(java.lang.String)">Timer</A></B>(java.lang.String name)</CODE>
\r
121 Creates a timer.</TD>
\r
125 <!-- ========== METHOD SUMMARY =========== -->
\r
127 <A NAME="method_summary"><!-- --></A>
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
130 <TD COLSPAN=2><FONT SIZE="+2">
\r
131 <B>Method Summary</B></FONT></TD>
\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
135 <CODE> long</CODE></FONT></TD>
\r
136 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#getCurrentTime()">getCurrentTime</A></B>()</CODE>
\r
139 Returns the current time.</TD>
\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
143 <CODE>static void</CODE></FONT></TD>
\r
144 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
\r
147 The main program for performing simple tests. </TD>
\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
151 <CODE> void</CODE></FONT></TD>
\r
152 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#reset()">reset</A></B>()</CODE>
\r
155 Resets the timer as if it has never run before.</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE> void</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#showTimes()">showTimes</A></B>()</CODE>
\r
163 Shows timing stats. </TD>
\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
167 <CODE> void</CODE></FONT></TD>
\r
168 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#showTimes(long)">showTimes</A></B>(long overall)</CODE>
\r
171 Shows timing stats. </TD>
\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
175 <CODE> void</CODE></FONT></TD>
\r
176 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#showTimesLong(long)">showTimesLong</A></B>(long overall)</CODE>
\r
179 Shows detailed timing stats. </TD>
\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
183 <CODE> void</CODE></FONT></TD>
\r
184 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#showTimesShort(long)">showTimesShort</A></B>(long overall)</CODE>
\r
187 Shows brief timing stats. </TD>
\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
191 <CODE>static void</CODE></FONT></TD>
\r
192 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#showTimesShortTitle(java.lang.String)">showTimesShortTitle</A></B>(java.lang.String title)</CODE>
\r
195 Shows the timing stats title.</TD>
\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
199 <CODE> void</CODE></FONT></TD>
\r
200 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#start()">start</A></B>()</CODE>
\r
203 Starts the timer running.</TD>
\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
207 <CODE> void</CODE></FONT></TD>
\r
208 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#stop()">stop</A></B>()</CODE>
\r
211 Stops the timer.</TD>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
215 <CODE> void</CODE></FONT></TD>
\r
216 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/Timer.html#stop(boolean)">stop</A></B>(boolean verbose)</CODE>
\r
219 Stops the timer.</TD>
\r
222 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
223 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
224 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
225 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
227 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
228 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
234 <!-- ============ FIELD DETAIL =========== -->
\r
237 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
239 <A NAME="constructor_detail"><!-- --></A>
240 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
241 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
242 <TD COLSPAN=1><FONT SIZE="+2">
\r
243 <B>Constructor Detail</B></FONT></TD>
\r
247 <A NAME="Timer(java.lang.String)"><!-- --></A><H3>
\r
250 public <B>Timer</B>(java.lang.String name)</PRE>
\r
252 <DD>Creates a timer.
\r
254 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the timer</DL>
\r
256 <!-- ============ METHOD DETAIL ========== -->
\r
258 <A NAME="method_detail"><!-- --></A>
259 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
260 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
261 <TD COLSPAN=1><FONT SIZE="+2">
\r
262 <B>Method Detail</B></FONT></TD>
\r
266 <A NAME="reset()"><!-- --></A><H3>
\r
269 public void <B>reset</B>()</PRE>
\r
271 <DD>Resets the timer as if it has never run before.
\r
279 <A NAME="start()"><!-- --></A><H3>
\r
282 public void <B>start</B>()</PRE>
\r
284 <DD>Starts the timer running.
\r
292 <A NAME="getCurrentTime()"><!-- --></A><H3>
\r
293 getCurrentTime</H3>
\r
295 public long <B>getCurrentTime</B>()</PRE>
\r
297 <DD>Returns the current time.
\r
301 <DT><B>Returns:</B><DD>the current time</DL>
\r
306 <A NAME="stop(boolean)"><!-- --></A><H3>
\r
309 public void <B>stop</B>(boolean verbose)</PRE>
\r
311 <DD>Stops the timer.
\r
314 <DT><B>Parameters:</B><DD><CODE>verbose</CODE> - if <code>true</code>, print out details from
315 this run; otherwise, don't print the details</DL>
\r
320 <A NAME="stop()"><!-- --></A><H3>
\r
323 public void <B>stop</B>()</PRE>
\r
325 <DD>Stops the timer.
\r
333 <A NAME="showTimesLong(long)"><!-- --></A><H3>
\r
336 public void <B>showTimesLong</B>(long overall)</PRE>
\r
338 <DD>Shows detailed timing stats. If overall is non-zero, it represents
339 the overall processing time and a percentage of overall
340 time for this timer should be calculated and displayed.
\r
343 <DT><B>Parameters:</B><DD><CODE>overall</CODE> - the overall processing time in milliseconds or 0.</DL>
\r
348 <A NAME="showTimesShortTitle(java.lang.String)"><!-- --></A><H3>
\r
349 showTimesShortTitle</H3>
\r
351 public static void <B>showTimesShortTitle</B>(java.lang.String title)</PRE>
\r
353 <DD>Shows the timing stats title.
\r
356 <DT><B>Parameters:</B><DD><CODE>title</CODE> - shows the title and column headings for the time
362 <A NAME="showTimesShort(long)"><!-- --></A><H3>
\r
363 showTimesShort</H3>
\r
365 public void <B>showTimesShort</B>(long overall)</PRE>
\r
367 <DD>Shows brief timing stats. If overall is non-zero, it represents
368 the overall processing time and a percentage of overall
369 time for this timer should be calculated and displayed.
\r
372 <DT><B>Parameters:</B><DD><CODE>overall</CODE> - the overall processing time in milliseconds or 0.</DL>
\r
377 <A NAME="showTimes(long)"><!-- --></A><H3>
\r
380 public void <B>showTimes</B>(long overall)</PRE>
\r
382 <DD>Shows timing stats. If overall is non-zero, it represents
383 the overall processing time and a percentage of overall
384 time for this timer should be calculated and displayed.
\r
387 <DT><B>Parameters:</B><DD><CODE>overall</CODE> - the overall processing time in milliseconds or 0.</DL>
\r
392 <A NAME="showTimes()"><!-- --></A><H3>
\r
395 public void <B>showTimes</B>()</PRE>
\r
397 <DD>Shows timing stats. No overall percentage is shown with this
406 <A NAME="main(java.lang.String[])"><!-- --></A><H3>
\r
409 public static void <B>main</B>(java.lang.String[] args)</PRE>
\r
411 <DD>The main program for performing simple tests. Creates a timer
412 uses it and shows its output.
\r
415 <DT><B>Parameters:</B><DD><CODE>args</CODE> - program arguments (not used)</DL>
\r
418 <!-- ========= END OF CLASS DATA ========= -->
\r
422 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
423 <A NAME="navbar_bottom"><!-- --></A>
424 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
425 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
427 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
428 <A NAME="navbar_bottom_firstrow"><!-- --></A>
429 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
430 <TR ALIGN="center" VALIGN="top">
\r
431 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
432 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
433 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
434 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
435 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
436 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
437 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
441 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
447 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
448 <A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>
\r
449 <A HREF="../../../../../com/sun/speech/freetts/util/Utilities.html" title="class in com.sun.speech.freetts.util"><B>NEXT CLASS</B></A></FONT></TD>
\r
450 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
451 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
452 <A HREF="Timer.html" target="_top"><B>NO FRAMES</B></A>
\r
453 <SCRIPT type="text/javascript">
\r
456 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
461 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
467 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
468 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
469 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
470 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
473 <A NAME="skip-navbar_bottom"></A>
474 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob