Changeset 1112

Timestamp:

Sep 17, 2012 9:46:02 AM (11 years ago)

Author:

cschlep

Message:

added more rdef test cases to test-battery.mac

File:

• specdomain/trunk/src/specdomain/macros/test-battery.mac (modified) (10 diffs)

specdomain/trunk/src/specdomain/macros/test-battery.mac

@@ -7 +7 @@
 * sample file to test sphinx documentation of SPEC macro files
 
-This file contains SPEC macro fragments to test various 
+This file contains SPEC macro fragments to test various
 parts of the SPHINX documentation builder.
 """
@@ -25 +25 @@
 common/shutter
 ==============
- 
+
 NAME
    shutter.mac
- 
+
 SUMMARY
    Commands to control a fast photon shutter.
- 
+
 DESCRIPTION
    The macro causes the fast photon shutter to be opened immediately prior to
@@ -37 +37 @@
    delay time assures that the shutter is fully open before issuing the
    count command.
- 
+
    The photon shutter is controlled via an EPICS binary output channel, and
    the shutter status is optionally monitored via a binary input channel (in
    which case the delay time is not used, but the monitor signal is used to
    check for completion of the opening process).
- 
+
 AUTHOR
    Christian M. Schlepuetz (CS, cschlep)
- 
+
 CREATION DATE
    2004/11/06
- 
+
 COPYRIGHT
    Copyright 2006-2011 by the above authors (see AUTHOR/AUTHORS)
- 
+
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
- 
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
- 
+
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see http://www.gnu.org/licenses/.
- 
+
 VERSION::
- 
+
    $. Date: 2010-11-04 19:06:06 -0400 (Thu, 04 Nov 2010) $
    $. Author: cschlep $
    $. URL: file:///data/svn/software/spec/trunk/common/shutter.mac $
    $. Revision: 17 $
- 
+
 DEPENDENCIES
    Chained macro definitions affected by this macro:
-   
+
    - user_precount
    - user_getcounts
    - cleanup_always
- 
+
 HISTORY
    2004/11/06 (CS):
-   
-           - modified the first original version to comply with naming and format 
+
+           - modified the first original version to comply with naming and format
              conventions
            - implemented help-file support and wrote help texts.
              2010/03/30 (CS):
            - added the following global variables to make macro more easily portable::
-         
+
                     SHUTTER_CONTROL_PV      # EPICS PV name for the shutter control (bo)
                     SHUTTER_CONTROL_OPEN    # EPICS control value for open shutter
@@ -96 +96 @@
                     SHUTTER_IS_ON           # flag for automatic shutter control
                     SHUTTER_SLEEP_TIME      # SPEC sleep time after opening shutter
- 
+
    2010/07/23 (CS):
            - added SVN keywords (replacing CVS keywords)
- 
+
    2011/12/19 (CS):
            - reformatted code documentation to work with ROBODoc
            - added shutter_setup with following internal macros:
-         
+
              * _shutter_print_setup
              * _shutter_set_option
              * _clear_screen
-         
+
            - replaced SHUTTER_STATUS* with SHUTTER_MONITOR*
            - replaced global variables _OPEN with _OPEN_VAL and
@@ -122 +122 @@
 
     # EPICS PV of the binary output which controls the shutter
-    
+
     global SHUTTER_CONTROL_PV
            SHUTTER_CONTROL_PV = "X04SA-ES3-SC:FPS"
@@ -134 +134 @@
     # EPICS PV of the binary input which monitors the state of the shutter
     # if SHUTTER_MONITOR_PV = "", no monitoring is performed
-    
+
     global SHUTTER_MONITOR_PV
            SHUTTER_MONITOR_PV = ""
@@ -163 +163 @@
         """
         sh_help, shutter_help: Displays the shutter help text.
-        
+
         usage::
-        
+
            > sh_help
-        
+
         .. note::
            The help text is generated by simply displaying the text file
@@ -214 +214 @@
 '
 
-  # cleanup macro for ^C usage
-  rdef _cleanup3 \'resetUSAXS\'
-  rdef _cleanup3 \'\'
-     cdef("Fheader", fheader,  "UCOL", 0x20)
-     rdef Flabel \'""\'
+# cleanup macros for ^C usage
+rdef _cleanup3 \'resetUSAXS\'
+rdef _cleanup3 \'\'
+cdef("Fheader", fheader,  "UCOL", 0x20)
+rdef Flabel \'""\'
+
+
+# rdef of a macro function with no arguments
+#: open the shutter before an exposure
+rdef shutter_user_precount_func() \'{shutter_open}; \'
+
+#: Add :spec:rdef:`shutter_user_precount_func()` to :spec:cdef:`user_precount`
+cdef("user_precount", "{shutter_user_precount_func()}; ", "shutter_key")
+
+# rdef of a macro function with two arguments
+rdef maximum_value(a, b) '{
+  """
+  Return the larger of two values.
+
+  """
+
+  return a > b ? a : b
+}'
+
+#: Remove :spec:rdef:`shutter_user_precount_func()` from :spec:cdef:`user_precount`
+cdef("user_precount", "", "shutter_key", "delete")
 
 #==============================================================================
@@ -234 +255 @@
 global MULTI_IMGS # useful 8-ID's IMM fileformat; currently not used
 
-#: twice the ratio of a circle's circumference to its diameter    
+#: twice the ratio of a circle's circumference to its diameter
 constant TWO_PI 6.283
 local _newspaper        #: don't expect to see new ones
@@ -263 +284 @@
 #==============================================================================
 
-
 """End of $Id$"""