Changes between Version 2 and Version 3 of tankplayer
- Timestamp:
- 02/27/12 16:30:38 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
tankplayer
v2 v3 3 3 = [wiki:Earthworm Earthworm] Module: tankplayer = 4 4 '''Contributed by: ''' 5 5 6 == Function == 6 7 Simulates an adsend module: reads a waveform file and puts waveform messages in shared memory in pseudo-real-time 8 7 9 == Details == 8 10 Tankplayer reads file(s) containing waveform messages (of either TYPE_ADBUF, TYPE_TRACEBUF, or TYPE_TRACEBUF2) from a single data source. It places the waveform messages into shared memory in simulated real time, using the delta-t between time-stamps in successive message headers to determine its timing. On startup, tankplayer reads the configuration file named on the command line. Commands in this file set up all parameters used in playing back waveform messages from a file to a shared memory ring. In the control file, lines may begin with a valid tankplayer command (listed below) or with one of 2 special characters: … … 93 95 In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and the values used by Calnet are listed after each command description. 94 96 97 The following list is organized by: 95 98 96 command '''arg1''' processed by function99 command [argument here] 97 100 98 CheckPeriod '''n''' tankplayer_config Playback 101 '''!CheckPeriod [n]''' 102 Processed by: tankplayer_config 103 Function: Playback 99 104 100 105 Defines the n seconds delay that the GetFromDir should be checked for new tank files. Note that this only effects checks when no tanks are being played back. … … 102 107 Default: 1 103 108 104 GetFromDir '''dir''' tankplayer_config Playback 109 '''GetFromDir [dir]''' 110 Processed by: tankplayer_config 111 Function: Playback 105 112 106 113 Defines the directory dir where to find tank files. This cannot be used in conjunction with WaveFile mode of running. If you set this parameter, then you may also set the OpenWait, OpenTries, CheckPeriod, and SaveDataFiles. … … 108 115 Default: none 109 116 110 InterMessageDelayMillisecs n_msecs tankplayer_config Playback 117 InterMessageDelayMillisecs [n_msecs] 118 Processed by: tankplayer_config 119 Function: Playback 111 120 Defines the speed with which to release tracebufs in units of milliseconds n_msecs This should be used with caution since it speeds up the playback and can overwhelm some modules if buffers are not sufficient sizes and CPU speed is not fast enough. Some experimentation is required to use this option for rapid playback. 121 112 122 Default: none 123 113 124 HeartBeatInt nsec tankplayer_config Earthworm setup 114 125 Defines the number of seconds nsec between TYPE_HEARTBEAT messages issued by tankplayer.