source: trunk/ewdoc/WEB_DOC/cmd/tankplayer_cmd.html @ 2160

Revision 2160, 9.9 KB checked in by paulf, 14 years ago (diff)

first inclusion

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<HTML>
2<HEAD>
3<TITLE>Earthworm Modules: Tankplayer commands</TITLE>
4</HEAD>
5
6<BODY TEXT="#000000" BGCOLOR="#FADFAF" LINK="#0000EE" VLINK="#551A8B" ALINK="#FF
70000">
8
9<CENTER><H1>Tankplayer Configuration File Commands</H1>
10<I>(last revised 25 November 1996)</I></CENTER>
11                                                         
12Page Index:<BR>
131.  <A HREF=#example>Example configuration file</A><BR>
142.  <A HREF=#function>Functional command listing</A><BR>
153.  <A HREF=#alphabet>Alphabetic command listing & description</A>
16<P>
17<!-- ADD HERE: Paragraph "On startup, xxxx reads the..." -->
18Tankplayer reads file(s) containing waveform messages (of either TYPE_ADBUF
19or TYPE_WAVEFORM) from a single data source.  It places the waveform messages
20into shared memory in simulated real time, using the delta-t between
21time-stamps in successive message headers to determine its timing.
22
23On startup, tankplayer reads the configuration file named on the command
24line.  Commands in this file set up all parameters used in playing back
25waveform messages from a file to a shared memory ring.  In the control file,
26lines may begin with a valid tankplayer command (listed below) or with one
27of 2 special characters:
28
29<BLOCKQUOTE><PRE>
30#  marks the line as a comment (example: # This is a comment).<BR>   
31@  allows control files to be nested; one control file can be
32   accessed from another with the command "@" followed by
33   a string representing the path name of the next control file
34   (example: @model.d).
35</BLOCKQUOTE></PRE>
36Command names must be typed in the control file exactly as shown in this
37document (upper/lower case matters!).
38<P>
39<A NAME="example">
40<H2>1.  EXAMPLE CONFIGURATION FILE</H2>
41<P>
42<PRE>
43
44# tankplayer config file for playing TYPE_ADBUF waveforms
45# tankplayer config file for playing waveform files
46
47RingName      WAVE_RING        # play waveforms into this ring
48MyModuleId    MOD_ADSEND_A     # as this module id
49PlayMsgType   TYPE_TRACEBUF    # msg type to read from file
50LogFile       1                # 0=no log; 1=keep log file
51HeartBeatInt  30               # seconds between heartbeats
52Pause         10               # seconds to pause between wavefiles
53StartUpDelay  10               # seconds to wait before playing 1st file
54ScreenMsg     1                # (optional) if non-zero, informational messages will be
55                               #   written to the screen as data is played
56# SendLate      10.0           # (optional) if present, packets will be
57                               #   timestamped this many seconds before
58                               #   current time;
59                               # if absent, packets will have original time
60                               #   stamps
61                               #
62Debug         1                # for verbosity
63
64# List of files to play (up to 50 allowed):
65WaveFile      e:\QAnew\900819a.ew1.tbuf
66</PRE>
67<P>
68<A NAME="function">
69<H2>2.  FUNCTIONAL COMMAND LISTING</H2>
70<P> 
71<!-- ADD HERE: Paragraph "Below are the commands recognized..." -->
72Below are the commands recognized by tankplayer, grouped by the function
73they influence.  All of the commands are required; they must be specified
74in the control file in order for tankplayer to operate.
75
76<!-- ADD HERE: The pre-formatted functional command listing      -->
77<!-- To make an anchor for each command, surround it with these: -->
78
79<PRE>   Earthworm system setup:
80                <A HREF=#HeartBeatInt>HeartBeatInt</A>          required
81                <A HREF=#MyModuleId>MyModuleId</A>              required
82                <A HREF=#RingName>RingName</A>          required
83
84        Waveform Playback:
85                <A HREF=#Pause>Pause</A>                        required
86                <A HREF=#PlayMsgType>PlayMsgType</A>            required
87                <A HREF=#StartUpDelay>StartUpDelay</A>          required
88                <A HREF=#WaveFile>WaveFile</A>          required
89   
90        Output Control:
91                <A HREF=#LogFile>LogFile</A>                    required
92
93</PRE>
94
95<A NAME="alphabet">
96<H2>3.  ALPHABETIC COMMAND LISTING & DESCRIPTION</H2>
97<P>
98In the following section, all configuration file commands are listed
99in alphabetical order.  Listed along with the command (bold-type) are
100its arguments (in red), the name of the subroutine that processes the
101command, and the function within the module that the command influences.
102A detailed description of the command and is also given.  Default values
103and the values used by Calnet are listed after each command description.
104<PRE><B>
105command <font color=red>arg1</font>                             processed by            function
106</PRE></B>
107<HR>
108
109<!-- ADD HERE: all commands; below is a sample command blank: -->
110
111<A NAME="HeartBeatInt">  <!-- command name as anchor inside quotes --> 
112<PRE><B>HeartBeatInt <font color=red>nsec</font>                        tankplayer_config       Earthworm setup</B><!-- command args ... -->           
113</PRE>
114<BLOCKQUOTE> <!-- command description goes here -->
115Defines the number of seconds <font color=red>nsec</font> between TYPE_HEARTBEAT messages
116issued by tankplayer.
117<PRE><!-- Default and example go here   -->
118Default:  none                          Calnet:  HeartBeatInt 15
119</PRE>
120</BLOCKQUOTE>
121<HR>
122
123<A NAME="LogFile">  <!-- command name as anchor inside quotes -->       
124<PRE><B>LogFile <font color=red>switch</font>                           tankplayer_config       output</B><!-- command args ... -->             
125</PRE>
126<BLOCKQUOTE> <!-- command description goes here -->
127Sets the on-off switch for writing a log file to disk.  If <font color=red>switch</font>
128is 0, no log file will be written.  If <font color=red>switch</font> is 1, tankplayer
129will write a daily log file(s) called tankplayerxx.log_yymmdd
130where xx is tankplayer's module id (set with "MyModuleId" command)
131and yymmdd is the current UTC date (ex: 960123) on the system clock. 
132The file(s) will be written in the EW_LOG directory (environment
133variable). 
134<PRE><!-- Default and example go here   -->
135Default:  none
136</PRE>
137</BLOCKQUOTE>
138<HR>
139
140<A NAME="MyModuleId">  <!-- command name as anchor inside quotes -->   
141<PRE><B>MyModuleId <font color=red>mod_id</font>                        tankplayer_config       Earthworm setup</B><!-- command args ... -->           
142</PRE>
143<BLOCKQUOTE> <!-- command description goes here -->
144Sets the module id for labeling all outgoing messages. <font color=red>mod_id</font> is
145a character string (valid strings are listed in earthworm.d) that
146relates (in earthworm.d) to a unique single-byte number.  Tankplayer
147also places this module id in the module id field of each waveform
148message header before it puts the message into shared memory.
149<PRE><!-- Default and example go here   -->
150Default:  none                         
151Example:  MyModuleId MOD_ADSEND_A
152</PRE>
153</BLOCKQUOTE>
154<HR>
155
156<A NAME="Pause">  <!-- command name as anchor inside quotes --> 
157<PRE><B>Pause <font color=red>nsec</font>                               tankplayer_config       Playback</B><!-- command args ... -->           
158</PRE>
159<BLOCKQUOTE> <!-- command description goes here -->
160Defines the integer number of seconds <font color=red>nsec</font> to pause after completing
161the playback of one waveform file before starting the playback of
162the next.  Tankplayer will continue to issue its heartbeat while
163it is in pause-mode.
164<PRE><!-- Default and example go here   -->
165Default:  none
166Example:  Pause 15
167</PRE>
168</BLOCKQUOTE>
169<HR>
170
171<A NAME="PlayMsgType">  <!-- command name as anchor inside quotes -->   
172<PRE><B>PlayMsgType <font color=red>type</font>                 tankplayer_config       Playback</B><!-- command args ... -->           
173</PRE>
174<BLOCKQUOTE> <!-- command description goes here -->
175Tells tankplayer what type of message the waveform file(s) contain. 
176<font color=red>type</font> is a character string (valid strings are listed in earthworm.d)
177that relates (in earthworm.d) to a unique single-byte number.  By the
178message-type, tankplayer knows the format of the waveform message;
179currently tankplayer only knows how to read and manipulate TYPE_ADBUF
180and TYPE_WAVEFORM waveform messages.
181<PRE><!-- Default and example go here   -->
182Default:  none
183Example:  PlayMsgType TYPE_ADBUF
184</PRE>
185</BLOCKQUOTE>
186<HR>
187
188<A NAME="RingName">  <!-- command name as anchor inside quotes -->     
189<PRE><B>RingName <font color=red>ring</font>                            tankplayer_config       Earthworm setup</B><!-- command args ... -->           
190</PRE>
191<BLOCKQUOTE> <!-- command description goes here -->
192Tells tankplayer which shared memory region to use for output.
193<font color=red>ring</font> is a character string (valid strings are listed in earthworm.d)
194that relates (in earthworm.d) to a unique number for the key to the
195shared memory region.
196<PRE><!-- Default and example go here   -->
197Default:  none                          Calnet:  RingName WAVE_RING
198</PRE>
199</BLOCKQUOTE>
200<HR>
201
202<A NAME="StartUpDelay">  <!-- command name as anchor inside quotes --> 
203<PRE><B>StartUpDelay <font color=red>xsec</font>                        tankplayer_config       Playback</B><!-- command args ... -->           
204</PRE>
205<BLOCKQUOTE> <!-- command description goes here -->
206Defines the integer number of seconds <font color=red>xsec</font> to wait on startup
207before beginning the playback of the first waveform file. 
208Tankplayer will continue to issue its heartbeat while it is in
209startup-delay mode.
210<PRE><!-- Default and example go here   -->
211Default:  none
212Example:  StartUpDelay 45
213</PRE>
214</BLOCKQUOTE>
215<HR>
216
217<A NAME="WaveFile">  <!-- command name as anchor inside quotes -->     
218<PRE><B>WaveFile <font color=red>path-file</font>                       tankplayer_config       Playback</B><!-- command args ... -->           
219</PRE>
220<BLOCKQUOTE> <!-- command description goes here -->
221Gives the name <font color=red>path-file</font> of one waveform file that tankplayer should
222play back.  <font color=red>path-file</font> is a character string up to 45 characters long.
223Up to 50 "WaveFile" commands may be issued.  Tankplayer will play
224the files in the order that they were listed in the configuration
225file, pausing between files by amount of time set in the "Pause"
226command.  All files must contain the same type of waveform message
227(specified in the "PlayMsgType" command).
228<PRE><!-- Default and example go here   -->
229Default:  none
230Example:  WaveFile  event1.waves</PRE>
231</BLOCKQUOTE>
232<HR>
233
234<CENTER> 
235<A HREF="../modules.html">Module Index</A> |
236<A HREF="../ovr/tankplayer_ovr.html">Tankplayer Overview</A>
237</CENTER>
238
239
240<!-- USGS-required stuff at the end -->
241<HR>
242<ADDRESS>
243The URL of this page is  <B>[http://gldbrick.cr.usgs.gov/ew-doc/cmd/tankplayer_cmd.html]</B><BR>
244Contact: <B>dietz@usgs.gov</B><BR>
245</ADDRESS>
246</BODY>
247</HTML>
Note: See TracBrowser for help on using the repository browser.