>  Docs Center  >  Libraries  >  JHU/APL/S1R  >  EVENT_LOG

EVENT_LOG

EVENT_LOG

Name


      EVENT_LOG

Purpose


      Enter an event into the latest event log file.

Category


Calling Sequence


      event_log, txt

Inputs


      txt = Short text string to enter into event log. in
        May also have multiple lines (Time tag will be on
        the preceding line, same as /TWOLINE).

Keyword Parameters


Keywords


        /TWOLINE Use two lines: time and txt (def=one line).
        /ADD means add given text to entry for last time tag.
            Any number of additional lines may be added.
        /SCREEN means also display given text on terminal screen.
        /LIST means display current event log.
        /FILE means display log file name.
        GETFILE=evfile Return event log file name.
        /NEW means start a new event log.
        SETFILE=file Optionally specified event file name.
        DIRECTORY=dir Event log directory (def=current).
        /DIFFERENCE gives time difference between last two entries.
        /LOG Enter the time difference in log file (with /DIFF).
        DSUB=dsub Can also put a time difference from last line
          on the current line, dsub is a string in txt to replace
          with the time difference (txt can be a text array).
          The 4 D* keywords below work with DSUB.
        DUNITS=dun Time units for time difference:
          's'=sec (def), 'm'=min, 'h'=hrs, 'd'=days.
          For example:
            event_log,'Processing ($)',dsub='$',dunits='m'
          gives:
            Wed Feb 18 17:19:35 2009 --- Processing (1.500 min)
        DFORM=dfmt Format for time difference (else default).
          Must be a valid IDL format, like '(F7.2)'. Any spaces
          on ends is trimmed off.
        DSTART=start Optional start time to use instead of time
          from previous line. Can be a date/time string or JS.
        DBACK=dback # lines to look back from line currently being
          added to get start time (def=1). Must use with DSUB.
        TAG=tag Look for the first occurance of TAG in the last
          line of the log file. Return the matching word in VALUE.
        VALUE=val First word in last log file line containing TAG.
          Example: if last log line is:
              DK processing complete: dk_191_1.res
          and TAG='dk_' then VALUE returns 'dk_191_1.res'
          TAG could also have been '.res' with same results.

Outputs


Common Blocks


Notes


      Notes: To have an event entered into the latest event
        log just call with the desired event text. If an event
        log file does not exist one will be created.
        To start a new event file just use the keyword /NEW.
        The event file names are always of the form:
          yymmmdd_hhmm.event_log like 95May15_1242.event_log
          except when SETFILE=file is used to override this.

Modification History


      R. Sterner, 1995 May 15
      R. Sterner, 1995 Jul 10 --- Added /DIFFERENCE keyword.
      R. Sterner, 1995 Aug 7 --- Added SETFILE keyword.
      R. Sterner, 2002 Aug 16 --- Made SETFILE work better.
      R. Sterner, 2002 Dec 16 --- Fixed a dir problem in SETFILE.
      R. Sterner, 2002 Dec 17 --- Made undefined dir be a null string.
      R. Sterner, 2006 Apr 27 --- Added GETFILE=file.
      R. Sterner, 2007 Aug 22 --- Made SETFILE work better.
      R. Sterner, 2009 Feb 18 --- Added DSUB=ds, DUNITS=du, DFORM=df
      R. Sterner, 2009 Feb 19 --- Added DSTART=start. Added flush, lun.
      R. Sterner, 2009 Feb 20 --- Added DBACK=nb.
      R. Sterner, 2010 Jul 13 --- Converted arrays from () to [].
      R. Sterner, 2010 Sep 09 --- Fixed SETFILE (again).
  Copyright (C) 1995, Johns Hopkins University/Applied Physics Laboratory
  This software may be used, copied, or redistributed as long as it is not
  sold and this copyright notice is reproduced on each copy made. This
  routine is provided as is without any express or implied warranties
  whatsoever. Other limitations apply as described in the file disclaimer.txt.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us