source: TI03-DataExtractor/branches/old_stuff/dx-webservice/doc/requestDict_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx-webservice/doc/requestDict_module.txt@793
Revision 793, 1.6 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1Help on module requestDict:
2
3NAME
4    requestDict
5
6FILE
7    /usr/local/dx-0.1.1/requestDict.py
8
9DESCRIPTION
10    requestDict.py
11    ==============
12   
13    Holds a wrapper class to improve access to request dictionary objects.
14
15CLASSES
16    RequestDict
17   
18    class RequestDict
19     |  Class wrapper around request object to group access to certain variables
20     |  in the dictionary.
21     | 
22     |  Methods defined here:
23     | 
24     |  __getitem__(self, key)
25     |      Method - wrap get item method on the internal dictionary.
26     | 
27     |  __init__(self, requestDict)
28     |      Method to create instance pointer to requestDict.
29     | 
30     |  __repr__(self)
31     |      Method - wrap print method for the internaldictionary.
32     | 
33     |  getHorizontalBounds(self)
34     |      getHorizontalBounds method - returns the tuple of horizontal bounds
35     |      or None if they don't exist.
36     | 
37     |  getNumDatasets(self)
38     |      Method - returns the current number of datasets selected.
39     | 
40     |  getTemporalDimension(self, dset_num)
41     |      Method to return the start time, end time and time interval (value, units).
42     | 
43     |  getVariableID(self, dset_num)
44     |      getVariableID method - chops up the variable name we have to create
45     |      the variable ID to call in the file.
46     | 
47     |  getVerticalDimension(self, dset_num)
48     |      getVerticalDimension method - returns the tuple of (level_list, level_units).
49     | 
50     |  has_key(self, key)
51     |      Method - wrap has_key method on the internal dictionary.
52     | 
53     |  keys(self)
54     |      Method - wrapper for the internal dictionary.
55
Note: See TracBrowser for help on using the repository browser.