Changeset 41543 for trunk

Timestamp:

Apr 9, 2021, 4:03:31 PM (5 years ago)

Author:

eugene

Message:

added comments to utility macros; added various utility macros previously spread among pantasks input files; moved ops specific macros out of pantasks.pro and into the corresponding input files (tasks.revert.off, tasks.revert.on)

File:

• trunk/ippTasks/pantasks.pro (modified) (23 diffs)

trunk/ippTasks/pantasks.pro

@@ -41 +41 @@
 
 # user functions to manage databases
-macro add.database
+macro add.database -c "add a database to this pantasks"
   if ($0 != 2)
     echo "USAGE: add.database (db)"
@@ -66 +66 @@
 end
 
-macro del.database
+macro del.database -c "remove a database from this pantasks" 
   if ($0 != 2)
     echo "USAGE: del.database (db)"
@@ -78 +78 @@
 end
 
-macro show.databases
+macro show.databases -c "list the databases for this pantasks"
   if ($0 != 1)
     echo "USAGE: show.databases"
@@ -97 +97 @@
 
 # user functions to manipulate labels
-macro add.label
+macro add.label -c "add a label to this pantasks"
   if ($0 != 2)
     echo "USAGE: add.label (label)"
@@ -122 +122 @@
 end
 
-macro del.label
+macro del.label -c "remove a label from this pantasks"
   if ($0 != 2)
     echo "USAGE: del.label (label)"
@@ -134 +134 @@
 end
 
-macro show.labels
+macro show.labels -c "list labels for this pantasks"
   if ($0 != 1)
     echo "USAGE: show.labels"
@@ -152 +152 @@
 end
 
-macro save.labels
+macro save.labels -c "save the currently defined labels in the file labels.list"
   if ($0 != 1)
     echo "USAGE: save.labels"
@@ -171 +171 @@
 end
 
-macro load.labels
+macro load.labels -c "read a list of labels from the file labels.list"
   if ($0 != 1)
     echo "USAGE: load.labels"
@@ -190 +190 @@
 end
 
+## XXX these are very Pan-STARRS specific
 macro init.isp
   list DB -add isp
@@ -224 +225 @@
 # need the ability to activate or deactivate specific tasks...
 
+# XXX move this to the detrend pantasks:
 macro detrend.on
   detproc.on
@@ -264 +266 @@
 end
 
+# XXX move this to the stdscience pantasks, remove detrend & flatcorr
 macro all.on
   detrend.on
@@ -288 +291 @@
 end
 
+# move to specific pantasks inputs
 macro module.tasks
   module register.pro
@@ -315 +319 @@
 end
 
-macro showcommand
+macro showcommand -c "print out the current command (used within tasks)"
   local n 
 
@@ -338 +342 @@
 
 # Add standard arguments to the poll functions
-macro add_poll_args
+macro add_poll_args -c "add standard poll options to commands (used within tasks)"
     if ($0 != 2)
         echo "Must pass in the command of interest, and this function will supplement"
@@ -350 +354 @@
 end
 
-macro add_poll_labels
+macro add_poll_labels -c "add standard labels to poll functions (used within tasks)"
     if ($0 != 2)
         echo "Must pass in the command of interest, and this function will supplement"
@@ -368 +372 @@
 end
 
-macro add_standard_args
+macro add_standard_args -c "add standard options (dbname, no-op, no-update) to commands (used within tasks)"
   if ($0 != 2)
     echo "Must pass in the command of interest, and this function will supplement"
@@ -394 +398 @@
 
 
-macro process_exit
+macro process_exit -c "common handler for task exit"
   if ($0 != 4)
     echo "USAGE: process_exit (bookName) (pageName) (exitCode)"
@@ -475 +479 @@
 
 ## XXX for the moment, remove all errors
-macro process_cleanup
+macro process_cleanup -c "standard handler to cleanup the books"
   if ($0 != 2)
     echo "USAGE: process_cleanup (bookname)"
@@ -495 +499 @@
 end
 
-macro set.poll
+macro set.poll -c "set the POLL_LIMIT value"
   if ($0 != 2)
     echo "USAGE:set.poll (value)"
@@ -504 +508 @@
 end
 
-macro get.poll
+macro get.poll -c "get the POLL_LIMIT value"
   echo "poll limit: $POLL_LIMIT"
 end
@@ -521 +525 @@
 end
 
-
-
+macro change_polllimit -c "set the POLL_LIMIT value (same as set.poll)"
+    $POLL_LIMIT = $1
+end
+
+macro change_runexec
+    $RUNEXEC = $1
+end
+
+macro change_runpoll
+    $RUNPOLL = $1
+end
+
+macro print_polllimit
+    echo $POLL_LIMIT
+end
+
+macro print_runexec
+    echo $RUNEXEC
+end
+
+macro print_runpoll
+    echo $RUNPOLL
+end
+
+macro change_loadexec
+    $LOADEXEC = $1
+end
+
+macro change_loadpoll
+    $LOADPOLL = $1
+end
+
+macro print_loadexec
+    echo $LOADEXEC
+end
+
+macro print_loadpoll
+    echo $LOADPOLL
+end
 
 macro set.verbosity
@@ -752 +793 @@
 end
 
+macro show.books
+  book list
+end
+
 macro del.page.from.book
   if ($0 != 3)
@@ -761 +806 @@
 end
 
-macro tasks.revert.off
-    chip.revert.off
-    camera.revert.off
-    fake.revert.off
-    warp.revert.off
-    diff.revert.off
-    stack.revert.off
-end
-macro tasks.revert.on
-    chip.revert.on
-    camera.revert.on
-    fake.revert.on
-    warp.revert.on
-    diff.revert.on
-    stack.revert.on
-end
-
+macro set.opihi.verbose
+  if ($0 != 2)
+    echo "USAGE: set.opihi.verbose (on/off)"
+    break
+  end
+
+  opihi verbose $1
+end
+
+# identical to 'set.opihi.verbose'
+macro opihi.verbosity
+  opihi verbose $1
+end
+
+macro set.server.verbose
+  if ($0 != 2)
+    echo "USAGE: set.server.verbose (on/off)"
+    break
+  end
+
+  verbose $1
+end
+
+macro set.output
+  if ($0 != 2)
+   echo "USAGE: set.output (destination)"
+   break
+  end
+  output $1  
+end
+
+macro show.output
+  output -current currentOutput
+  echo $currentOutput
+end
+
+