1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2<HTML><HEAD>
3		<TITLE>User's Reference - Trace</TITLE>
4		<META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA
5MINING">
6	<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
7</HEAD><BODY BGCOLOR="#FFFFFF" link="#00004b" vlink="#4b004b">
8		<TABLE width=510 border=0 cellpadding=0 cellspacing=0>
9			<TR>
10				<TD><IMG src="../images/spacer.gif" width=80 height=1></TD>
11				<TD><IMG src="../images/spacer.gif" width=49 height=1></TD>
12				<TD><IMG src="../images/spacer.gif" width=24 height=1></TD>
13				<TD><IMG src="../images/spacer.gif" width=100 height=1></TD>
14				<TD><IMG src="../images/spacer.gif" width=3 height=1></TD>
15				<TD><IMG src="../images/spacer.gif" width=127 height=1></TD>
16				<TD><IMG src="../images/spacer.gif" width=6 height=1></TD>
17				<TD><IMG src="../images/spacer.gif" width=50 height=1></TD>
18				<TD><IMG src="../images/spacer.gif" width=71 height=1></TD>
19			</TR>
20			<TR>
21				<TD colspan=9><IMG src="../images/flcgh_01.gif" width=510 height=24 alt="OpenDX - Documentation"></TD>
22			</TR>
23			<TR>
24				<TD colspan=2><A href="../allguide.htm"><IMG src="../images/flcgh_02.gif" width=129 height=25 border="0" alt="Full Contents"></A></TD>
25				<TD colspan=3><A href="../qikguide.htm"><IMG src="../images/flcgh_03.gif" width=127 height=25 border="0" alt="QuickStart Guide"></A></TD>
26				<TD><A href="../usrguide.htm"><IMG src="../images/flcgh_04.gif" width=127 height=25 border="0" alt="User's Guide"></A></TD>
27				<TD colspan=3><B><A href="../refguide.htm"><IMG src="../images/flcgh_05d.gif" width=127 height=25 border="0" alt="User's Reference"></A></B></TD>
28			</TR>
29			<TR>
30				<TD><A href="refgu157.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD>
31				<TD colspan=2><A href="refgu159.htm"><IMG src="../images/flcgh_07.gif" width=73 height=17 border="0" alt="Next Page"></A></TD>
32				<TD><A href="../refguide.htm"><IMG src="../images/flcgh_08.gif" width=100 height=17 border="0" alt="Table of Contents"></A></TD>
33				<TD colspan=3><A href="refgu009.htm"><IMG src="../images/flcgh_09.gif" width=136 height=17 border="0" alt="Partial Table of Contents"></A></TD>
34				<TD><A href="refgu175.htm"><IMG src="../images/flcgh_10.gif" width=50 height=17 border="0" alt="Index"></A></TD>
35				<TD><A href="../srchindx.htm"><IMG src="../images/flcgh_11.gif" width=71 height=17 border="0" alt="Search"></A></TD>
36			</TR>
37		</TABLE>
38		<H3><A name="HDRTRACE" ></A>Trace</H3>
39		<A NAME="IDX745"></A><A NAME="IDX746"></A>
40<P><STRONG>Category</STRONG>
41<P>
42<A HREF="refgu008.htm#HDRCATDBG">Debugging</A>
43<P><STRONG>Function</STRONG>
44<P>
45Enable or disables tracing options.
46<P><STRONG>Syntax</STRONG>
47<PRE>
48Trace(<STRONG>what, how</STRONG>);
49</PRE>
50<P><STRONG>Inputs</STRONG>
51<BR>
52<TABLE BORDER>
53<TR>
54<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Name
55</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Type
56</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Default
57</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">Description
58</TH></TR><TR>
59<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>what</STRONG></TT>
60</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">string
61</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">none
62</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">the object to be traced
63</TD></TR><TR>
64<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>how</STRONG></TT>
65</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">integer
66</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">1
67</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">0: set tracing off
68<BR>
691: set tracing on
70</TD></TR></TABLE>
71<P><STRONG>Functional Details</STRONG>
72<P>
73<TABLE CELLPADDING="3">
74<TR VALIGN="TOP"><TD><P><B><TT><STRONG>what</STRONG></TT>
75</B></TD><TD><P>is (1) a keyword specifying the object to be traced <I>or</I>
76(2) a set of letters specifying a group
77of debug message classes, as used by the
78<TT><STRONG>DXEnableDebug()</STRONG></TT>
79library function (see <I>IBM Visualization Data Explorer Programmer&#39;s
80Reference</I>).
81<P>
82At present, the only keyword value allowed for this parameter is
83<TT><STRONG>"time"</STRONG></TT>:
84<TT><STRONG>Trace("time", 1);</STRONG></TT> will begin the trace, and
85<TT><STRONG>Trace("time", 0);</STRONG></TT> will print a record of time use
86since the tracing was started.
87The output appears in the Message window.
88<BR>
89If <TT><STRONG>what</STRONG></TT> is a string of lowercase letters other than
90<TT><STRONG>time</STRONG></TT>, the module calls the
91<TT><STRONG>DXEnableDebug</STRONG></TT> library
92function.
93(The uppercase letters A-Z and the numbers 0-9 are reserved
94for system use).
95</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>how</STRONG></TT>
96</B></TD><TD><P>specifies whether the trace option is activated or not.
97</TD></TR></TABLE>
98<P><B>Note: </B>If the executive is started with the flag <TT>-timing</TT> on,
99the command <TT>Trace(&quot;time&quot;, 0)</TT> causes all module
100entry and exit times to be printed.
101In the VPE window, this command can be
102
103enabled using the Debug Tracing button
104in the <TT><STRONG>Commands</STRONG></TT> menu of the
105
106Message window (see
107<A HREF="usrgu046.htm#HDRDEBUG">8.2 , "Using the Message Window"</A> in <I>IBM
108Visualization Data Explorer User&#39;s Guide</I>).
109<P><STRONG>Script Language Example</STRONG>
110<P>
111In this example, the module traces the use of time by Isosurface.
112<PRE>
113electrondensity = Import("/usr/local/dx/samples/data/watermolecule");
114electrondensity = Partition(electrondensity);
115camera = AutoCamera(electrondensity, width=5);
116Trace("time", 1);
117isosurface = Isosurface(electrondensity, 0.3);
118Trace("time", 0);
119Display(isosurface, \camera);
120</PRE>
121<P><STRONG>See Also</STRONG>
122<P>
123&nbsp;<A HREF="refgu166.htm#HDRUSAGE">Usage</A>
124		<P>
125		<HR>
126		<DIV align="center">
127			<P><A href="../allguide.htm"><IMG src="../images/foot-fc.gif" width="94" height="18" border="0" alt="Full Contents"></A> <A href="../qikguide.htm"><IMG src="../images/foot-qs.gif" width="94" height="18" border="0" alt="QuickStart Guide"></A> <A href="../usrguide.htm"><IMG src="../images/foot-ug.gif" width="94" height="18" border="0" alt="User's Guide"></A> <A href="../refguide.htm"><IMG src="../images/foot-ur.gif" width="94" height="18" border="0" alt="User's Reference"></A></P>
128		</DIV>
129		<DIV align="center">
130			<P><FONT size="-1">[ <A href="http://www.research.ibm.com/dx">OpenDX Home at IBM</A>&nbsp;|&nbsp;<A href="http://www.opendx.org/">OpenDX.org</A>&nbsp;] </FONT></P>
131			<P></P>
132		</DIV>
133		<P></P>
134	</BODY></HTML>
135