source: TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/request.html @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/request.html@793
Revision 793, 7.5 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1
2<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module request</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>request</strong></big></big></font></td
10><td align=right valign=bottom
11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/dx-0.1.1/request.py">/usr/local/dx-0.1.1/request.py</a></font></td></tr></table>
12    <p><tt>request.py<br>
13===========<br>
14&nbsp;<br>
15Request&nbsp;module&nbsp;for&nbsp;the&nbsp;data&nbsp;extractor&nbsp;package.<br>
16&nbsp;<br>
17This&nbsp;module&nbsp;holds&nbsp;the&nbsp;<a href="#Requestdb">Requestdb</a>&nbsp;class&nbsp;that&nbsp;is&nbsp;used<br>
18to&nbsp;store&nbsp;the&nbsp;contents&nbsp;of&nbsp;user&nbsp;requests.</tt></p>
19<p>
20<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
21<tr bgcolor="#aa55cc">
22<td colspan=3 valign=bottom>&nbsp;<br>
23<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
24   
25<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
26<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
27</td><td width="25%" valign=top><a href="random.html">random</a><br>
28</td><td width="25%" valign=top><a href="shelve.html">shelve</a><br>
29</td><td width="25%" valign=top><a href="time.html">time</a><br>
30</td></tr></table></td></tr></table><p>
31<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
32<tr bgcolor="#ee77aa">
33<td colspan=3 valign=bottom>&nbsp;<br>
34<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
35   
36<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
37<td width="100%"><dl>
38<dt><font face="helvetica, arial"><a href="request.html#Requestdb">Requestdb</a>
39</font></dt></dl>
40 <p>
41<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
42<tr bgcolor="#ffc8d8">
43<td colspan=3 valign=bottom>&nbsp;<br>
44<font color="#000000" face="helvetica, arial"><a name="Requestdb">class <strong>Requestdb</strong></a></font></td></tr>
45   
46<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
47<td colspan=2><tt><a href="#Requestdb">Requestdb</a>&nbsp;method&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;this&nbsp;holds&nbsp;a&nbsp;user&nbsp;request&nbsp;that<br>
48is&nbsp;stored&nbsp;in&nbsp;a&nbsp;python&nbsp;shelve&nbsp;object.<br>&nbsp;</tt></td></tr>
49<tr><td>&nbsp;</td>
50<td width="100%">Methods defined here:<br>
51<dl><dt><a name="Requestdb-__init__"><strong>__init__</strong></a>(self, request_id<font color="#909090">=None</font>)</dt><dd><tt>__init__&nbsp;method&nbsp;-&nbsp;generates&nbsp;a&nbsp;unique&nbsp;id&nbsp;for&nbsp;a&nbsp;request&nbsp;if&nbsp;the<br>
52requests&nbsp;object&nbsp;does&nbsp;not&nbsp;already&nbsp;exist.</tt></dd></dl>
53
54<dl><dt><a name="Requestdb-clearRequest"><strong>clearRequest</strong></a>(self, request)</dt><dd><tt>Clears&nbsp;all&nbsp;the&nbsp;user-selected&nbsp;content&nbsp;of&nbsp;a&nbsp;request.</tt></dd></dl>
55
56<dl><dt><a name="Requestdb-getNumDatasets"><strong>getNumDatasets</strong></a>(self)</dt><dd><tt>getNumDatasets&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;current&nbsp;number&nbsp;of&nbsp;datasets<br>
57selected.</tt></dd></dl>
58
59<dl><dt><a name="Requestdb-getRequestID"><strong>getRequestID</strong></a>(self)</dt><dd><tt>getRequestID&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;request&nbsp;ID.</tt></dd></dl>
60
61<dl><dt><a name="Requestdb-loadRequest"><strong>loadRequest</strong></a>(self)</dt><dd><tt>loadRequest&nbsp;method&nbsp;-&nbsp;[not&nbsp;yet&nbsp;implemented]</tt></dd></dl>
62
63<dl><dt><a name="Requestdb-readRequest"><strong>readRequest</strong></a>(self)</dt><dd><tt>readRequest&nbsp;method&nbsp;-&nbsp;reads&nbsp;the&nbsp;current&nbsp;request&nbsp;from&nbsp;the&nbsp;python<br>
64shelve&nbsp;object.</tt></dd></dl>
65
66<dl><dt><a name="Requestdb-saveRequest"><strong>saveRequest</strong></a>(self)</dt><dd><tt>saveRequest&nbsp;method&nbsp;-&nbsp;[not&nbsp;yet&nbsp;implemented]</tt></dd></dl>
67
68<dl><dt><a name="Requestdb-writeRequest"><strong>writeRequest</strong></a>(self, request)</dt><dd><tt>writeRequest&nbsp;method&nbsp;-&nbsp;writes&nbsp;the&nbsp;current&nbsp;request&nbsp;to&nbsp;a&nbsp;python<br>
69shelve&nbsp;object.</tt></dd></dl>
70
71</td></tr></table></td></tr></table><p>
72<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
73<tr bgcolor="#55aa55">
74<td colspan=3 valign=bottom>&nbsp;<br>
75<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
76   
77<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
78<td width="100%"><strong>ADMIN_MAIL_ADDRESS</strong> = 'yourmail@yourhost'<br>
79<strong>ADMIN_NOTIFICATION</strong> = 0<br>
80<strong>BASEDIR</strong> = '/usr/local/dx'<br>
81<strong>CDAT_BIN_PATH</strong> = '/usr/local/cdat/bin'<br>
82<strong>CF_METADATA_GLOBAL_ATTRIBUTES</strong> = {'comments': 'Created by test data extractor.'}<br>
83<strong>CGI_NAME</strong> = 'http://localhost/cgi-bin/dxui.py'<br>
84<strong>CONFIRMATION_PAGE</strong> = 1<br>
85<strong>DEBUG</strong> = 1<br>
86<strong>EXTRAS_DIR</strong> = '/dx_extra'<br>
87<strong>HTML_DIR</strong> = '/usr/local/dx/html'<br>
88<strong>HTTP_OUTPUT_DIR</strong> = 'http://localhost/output'<br>
89<strong>HTTP_REQUEST_XML_DIR</strong> = 'http://localhost/request_xmls'<br>
90<strong>INPUT_DATASETS_FILE</strong> = '/usr/local/dx/datasets/inputDatasets.xml'<br>
91<strong>LEFT_LOGO</strong> = 'dx_logo.jpg'<br>
92<strong>LOCAL_CGI_NAME</strong> = '/srv/www/cgi-bin/cgiInterface.py'<br>
93<strong>LOCAL_MAIL_HOST</strong> = 'youroutbox.yourdomain'<br>
94<strong>LOCAL_PYTHONPATH</strong> = ['YOUR_CDAT/lib/python2.4', 'YOUR_CDAT/lib/python2.4/site-packages', 'YOUR_CDAT/cdat/lib/python2.4/site-packages/Numeric', 'YOUR_CDAT/lib/python2.3', 'YOUR_CDAT/lib/python2.3/site-packages', 'YOUR_CDAT/cdat/lib/python2.3/site-packages/Numeric']<br>
95<strong>LOCAL_RULES</strong> = 0<br>
96<strong>LOGO_DIR</strong> = '/dx_extra/logos'<br>
97<strong>MAP_APPLET</strong> = '/dx_extra/LiveMap_30/extractorMap.html'<br>
98<strong>MAX_FILE_SIZE</strong> = 1<br>
99<strong>MAX_NUM_DATASETS</strong> = 2<br>
100<strong>MESSAGE_TO_USERS</strong> = 'This is a test version of the Data Extractor so ...error occurs so that we can improve this service.'<br>
101<strong>NAPPY_PATH</strong> = '/usr/local/nappy'<br>
102<strong>OUTPUT_DIR</strong> = '/srv/www/htdocs/output'<br>
103<strong>OUTPUT_DIR_PERMISSION</strong> = 493<br>
104<strong>OUTPUT_FILE_GROUP</strong> = 'users'<br>
105<strong>OUTPUT_FILE_PERMISSION</strong> = 420<br>
106<strong>OUTPUT_FILE_USER</strong> = 'wwwrun'<br>
107<strong>OUTPUT_FORMATS</strong> = ['NetCDF', 'NASA Ames']<br>
108<strong>PACKAGE_NAME</strong> = 'Data Extractor'<br>
109<strong>PROCESS_LIST_DIR</strong> = '/usr/local/dx/processes'<br>
110<strong>REGISTRATION_PAGE</strong> = 'http://yourhost/your_link.html'<br>
111<strong>REQUEST_DIR</strong> = '/usr/local/dx/requests'<br>
112<strong>REQUEST_SIZE_LIMIT</strong> = 100<br>
113<strong>REQUEST_XML_DIR</strong> = '/srv/www/htdocs/request_xmls'<br>
114<strong>RESTRICTED_DATA</strong> = 0<br>
115<strong>RIGHT_LOGO</strong> = 'dx_logo.jpg'<br>
116<strong>TIMING_SCALE_FACTOR</strong> = 1.0000000000000001e-05<br>
117<strong>TOP_LEVEL</strong> = 'datasetGroup'<br>
118<strong>USER_HOMEDIR</strong> = '/var/lib/wwwrun'<br>
119<strong>VISUALISOR_NAME</strong> = '/cgi-bin/splatui-0.1.1.py'</td></tr></table>
120</body></html>
Note: See TracBrowser for help on using the repository browser.