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
7 BulkTimer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.util.BulkTimer 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="BulkTimer (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 PREV CLASS
\r
53 <A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.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="BulkTimer.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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
86 Class BulkTimer</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.util.BulkTimer</B>
\r
93 <DT>public class <B>BulkTimer</B><DT>extends java.lang.Object</DL>
\r
96 Provides a suite of timers that are used to collect and generate
97 performance metrics for FreeTTS.
\r
104 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
107 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <A NAME="field_summary"><!-- --></A>
110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
112 <TD COLSPAN=2><FONT SIZE="+2">
\r
113 <B>Field Summary</B></FONT></TD>
\r
115 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
117 <CODE>static <A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html" title="class in com.sun.speech.freetts.util">BulkTimer</A></CODE></FONT></TD>
\r
118 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#LOAD">LOAD</A></B></CODE>
\r
121 A BulkTimer that can be used by classes that need to
122 time their loading phase.</TD>
\r
126 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
128 <A NAME="constructor_summary"><!-- --></A>
129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
131 <TD COLSPAN=2><FONT SIZE="+2">
\r
132 <B>Constructor Summary</B></FONT></TD>
\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#BulkTimer()">BulkTimer</A></B>()</CODE>
\r
138 Creates a bulk timer.</TD>
\r
142 <!-- ========== METHOD SUMMARY =========== -->
\r
144 <A NAME="method_summary"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
147 <TD COLSPAN=2><FONT SIZE="+2">
\r
148 <B>Method Summary</B></FONT></TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> <A HREF="../../../../../com/sun/speech/freetts/util/Timer.html" title="class in com.sun.speech.freetts.util">Timer</A></CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#getTimer(java.lang.String)">getTimer</A></B>(java.lang.String name)</CODE>
\r
156 Gets the timer with the given name.</TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE> boolean</CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#isVerbose()">isVerbose</A></B>()</CODE>
\r
164 Checks to see if we are in verbose mode.</TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE> void</CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#setVerbose(boolean)">setVerbose</A></B>(boolean verbose)</CODE>
\r
172 Sets verbose mode.</TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> void</CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#show(java.lang.String)">show</A></B>(java.lang.String title)</CODE>
\r
180 Shows all of the collected times.</TD>
\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
184 <CODE> void</CODE></FONT></TD>
\r
185 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#start()">start</A></B>()</CODE>
\r
188 Starts the bulk timer. </TD>
\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
192 <CODE> void</CODE></FONT></TD>
\r
193 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#start(java.lang.String)">start</A></B>(java.lang.String name)</CODE>
\r
196 Starts the timer with the given name. </TD>
\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
200 <CODE> void</CODE></FONT></TD>
\r
201 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#stop()">stop</A></B>()</CODE>
\r
204 Stops the bulk timer.</TD>
\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
208 <CODE> void</CODE></FONT></TD>
\r
209 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html#stop(java.lang.String)">stop</A></B>(java.lang.String name)</CODE>
\r
212 Stops the timer with the given name.</TD>
\r
215 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
217 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
218 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
220 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
221 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
227 <!-- ============ FIELD DETAIL =========== -->
\r
229 <A NAME="field_detail"><!-- --></A>
230 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
231 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
232 <TD COLSPAN=1><FONT SIZE="+2">
\r
233 <B>Field Detail</B></FONT></TD>
\r
237 <A NAME="LOAD"><!-- --></A><H3>
\r
240 public static final <A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html" title="class in com.sun.speech.freetts.util">BulkTimer</A> <B>LOAD</B></PRE>
\r
242 <DD>A BulkTimer that can be used by classes that need to
243 time their loading phase.
\r
249 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
251 <A NAME="constructor_detail"><!-- --></A>
252 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
253 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
254 <TD COLSPAN=1><FONT SIZE="+2">
\r
255 <B>Constructor Detail</B></FONT></TD>
\r
259 <A NAME="BulkTimer()"><!-- --></A><H3>
\r
262 public <B>BulkTimer</B>()</PRE>
\r
264 <DD>Creates a bulk timer.
\r
268 <!-- ============ METHOD DETAIL ========== -->
\r
270 <A NAME="method_detail"><!-- --></A>
271 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
272 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
273 <TD COLSPAN=1><FONT SIZE="+2">
\r
274 <B>Method Detail</B></FONT></TD>
\r
278 <A NAME="start(java.lang.String)"><!-- --></A><H3>
\r
281 public void <B>start</B>(java.lang.String name)</PRE>
\r
283 <DD>Starts the timer with the given name. A BulkTimer can manage
284 any number of timers. The timers are referenced by name. A
285 timer is created the first time it is referenced.
\r
288 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the timer to start</DL>
\r
293 <A NAME="stop(java.lang.String)"><!-- --></A><H3>
\r
296 public void <B>stop</B>(java.lang.String name)</PRE>
\r
298 <DD>Stops the timer with the given name.
\r
301 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the timer</DL>
\r
306 <A NAME="start()"><!-- --></A><H3>
\r
309 public void <B>start</B>()</PRE>
\r
311 <DD>Starts the bulk timer. The BulkTimer maintains a timer for
312 itself (called SELF). This is used to measure the overall time
313 for a bulk timer. When timing data is displayed, the percentage
314 of total time is displayed. The total time is the time between
315 <code> start </code> and <code> end </code> calls on the
316 <code> BulkTimer </code> .
\r
324 <A NAME="stop()"><!-- --></A><H3>
\r
327 public void <B>stop</B>()</PRE>
\r
329 <DD>Stops the bulk timer.
\r
337 <A NAME="setVerbose(boolean)"><!-- --></A><H3>
\r
340 public void <B>setVerbose</B>(boolean verbose)</PRE>
\r
342 <DD>Sets verbose mode.
\r
345 <DT><B>Parameters:</B><DD><CODE>verbose</CODE> - the verbose mode</DL>
\r
350 <A NAME="isVerbose()"><!-- --></A><H3>
\r
353 public boolean <B>isVerbose</B>()</PRE>
\r
355 <DD>Checks to see if we are in verbose mode.
\r
359 <DT><B>Returns:</B><DD><code>true</code> if verbose mode; otherwise
360 <code>false</code>.</DL>
\r
365 <A NAME="getTimer(java.lang.String)"><!-- --></A><H3>
\r
368 public <A HREF="../../../../../com/sun/speech/freetts/util/Timer.html" title="class in com.sun.speech.freetts.util">Timer</A> <B>getTimer</B>(java.lang.String name)</PRE>
\r
370 <DD>Gets the timer with the given name.
\r
373 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the timer name
374 <DT><B>Returns:</B><DD>the timer with that name</DL>
\r
379 <A NAME="show(java.lang.String)"><!-- --></A><H3>
\r
382 public void <B>show</B>(java.lang.String title)</PRE>
\r
384 <DD>Shows all of the collected times.
\r
387 <DT><B>Parameters:</B><DD><CODE>title</CODE> - the title for the display</DL>
\r
390 <!-- ========= END OF CLASS DATA ========= -->
\r
394 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
395 <A NAME="navbar_bottom"><!-- --></A>
396 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
397 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
399 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
400 <A NAME="navbar_bottom_firstrow"><!-- --></A>
401 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
402 <TR ALIGN="center" VALIGN="top">
\r
403 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
404 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
405 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
406 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
407 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
408 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
409 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
413 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
419 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
420 PREV CLASS
\r
421 <A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html" title="class in com.sun.speech.freetts.util"><B>NEXT CLASS</B></A></FONT></TD>
\r
422 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
423 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
424 <A HREF="BulkTimer.html" target="_top"><B>NO FRAMES</B></A>
\r
425 <SCRIPT type="text/javascript">
\r
428 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
433 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
439 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
440 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
441 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
442 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
445 <A NAME="skip-navbar_bottom"></A>
446 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob