madCalculatorService is the class that allows remote access to the madCalculator.py script.

Like all my python cgi scripts, madCalculatorService has the following structure: the entire cgi is contained in one class, with a main function at the end which serves simply to call the __init__ function of the class. This __init__ function is responsible for calling all other class methods. It is made up of a single try block, with the purpose of reporting all exceptions in well-formatted text to both the user and the administrator. The __init__ function first makes sure the pythonlib can be found. It then calls setScriptState to validate the the cgi arguments, which are simply the arguments for the isprint command.

If any uncaught exception is thrown, its caught by the __init__ try block. If its an MadrigalError, additional information is available. The catch blocks attempt to display the error message on the screen by backing out of of large number of possible tags, which might prevent its display (in any case, the error message will always be available in the page source. The formatted error message is also sent to the email address given in the siteTab.txt metadata file.

This script is not meant to be used directly by a user, and thus is named Service. It is meant to be used by scripting languages such as Matlab that want to call madCalculator via the web

Input cgi arguments:

1. year - int (required)

2. month - int (required)

3. day - int (required)

4. hour - int (required)

5. min - int (required)

6. sec - int (required)

7. startLat - Starting geodetic latitude, -90 to 90 (required)

8. endLat - Ending geodetic latitude, -90 to 90 (required)

9. stepLat - Latitude step (0.1 to 90) (required)

10. startLong - Starting geodetic longitude, -180 to 180 (required)

11. endLong - Ending geodetic longitude, -180 to 180 (required)

12. stepLong - Longitude step (0.1 to 180) (required)

13. startAlt - Starting geodetic altitude, >= 0 (required)

14. endAlt - Ending geodetic altitude, > 0 (required)

15. stepAlt - Altitude step (>= 0.1) (required)

16. parms - comma delimited string of Madrigal parameters desired (required)

17. oneD - string in form <parm>,<value> This argument allows the user to set any number of one-D parameters to be used in the calculation. Value must be parameter name, comma, value as double. Example: &oneD=kinst,31.0&oneD=elm,45.0 (optional - 0 or more allowed)

Returns comma-delimited data, one line for each combination of lat, long, and alt, with the following fields:

1. latitude

2. longitude

3. altitude

4. Values for each Madrigal parameter listed in argument parms, separated by whitespace

Calls script madCalculator.py.

If error, returns error description

Change history:

Written by Bill Rideout Feb. 6, 2004

$Id: madCalculatorService_madCalculatorService.py.html 3304 2011-01-17 15:25:59Z brideout $

__init__ ( self )

createObjects ( self )

madCalculator ( self )

setScriptState ( self )