Changes between Initial Version and Version 1 of decompress_UA


Ignore:
Timestamp:
03/25/12 13:09:18 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • decompress_UA

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: decompress_UA = 
     4'''Contributed by: ''' 
     5 
     6== Function == 
     7The [wiki:compress_UA compress_UA] and decompress_UA modules implement the gencompress algorithm which is used with permission from Boulder Real Time Technologies, Inc., copyright 1997. 
     8 
     9== Details == 
     10The [wiki:compress_UA compress_UA] and decompress_UA modules implement the gencompress algorithm which is used with permission from Boulder Real Time Technologies, Inc., copyright 1997. 
     11 
     12[wiki:compress_UA compress_UA] inputs selected trace data messages (TYPE_TRACEBUF), compresses the samples via the BRTT algorithm, leaves the header intact, and outputs the resulting message as TYPE_TRACE_COMP_UA. Trace messages are selected via SCN names listed in the .d file. Wildcards are allowed. The compressed data output can be tagged with [wiki:compress_UA compress_UA]'s installation_id and module_id (normal Earthworm behavior), or with the installation_id and module_id of the original uncompressed message. 
     13 
     14Decompress_UA is the matching decompressor. Its output is identical to the input to the compressor. As with [wiki:compress_UA compress_UA], decompress_UA's output can be tagged with its own installation_id and module_id, or with those of the original message. This option allows the logo of the original data source to be preserved thru the compress/decompress operation. 
     15 
     16In order to run compress_UA and decompress_UA, you must add TYPE_TRACE_COMP_UA message to 'earthworm.d'. 
     17 
     18=== Example Configuration File === 
     19{{{ 
     20# 
     21#          Configuration File for decompress 
     22# 
     23MyModId     MOD_DECOMPRESS_UA   # This instance of pick_ew 
     24InRing              COMP_RING   # Transport ring to find compressed data on, 
     25OutRing             WAVE_RING   # Transport ring to write output to, 
     26HeartBeatInterval   15          # Heartbeat interval, in seconds, 
     27LogFile             1           # 0=write log to stderr/stdout, not to disk 
     28                                # 1=write a log file to disk 
     29                                # 2=write a module log but not to stderr/stdout 
     30 
     31GetWavesFrom  INST_WILDCARD MOD_WILDCARD  # only looks for msgtype:TYPE_TRACE_COMP_UA 
     32 
     33UseOriginalLogo     0           # 0=use decompress_UA's logo on outgoing TYPE_TRACEBUF msgs 
     34                                # non-zero=use instid&modid of original compressed msg 
     35                                #          on outgoing TYPE_TRACEBUF msg 
     36}}} 
     37 
     38== Helpful Hints ==