source: TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/requestCost_module.txt @ 793

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

Put all the old code in the old_stuff branch.

Line 
1Help on module requestCost:
2
3NAME
4    requestCost
5
6FILE
7    /usr/local/dx-0.1.1/requestCost.py
8
9DESCRIPTION
10    requestCost.py
11    ==============
12   
13    Contains the class RequestCost that is used to estimate the cost (in
14    data volume and processing time) of a user request.
15
16CLASSES
17    extractMetadata.MetadataExtractor
18        RequestCost
19   
20    class RequestCost(extractMetadata.MetadataExtractor)
21     |  Class used to estimate the cost of a request in terms of the data
22     |  volume produced and the processing time to produce the request.
23     |  There is also a localCostingRules method included for you to add your
24     |  own algorithms that relate to local rules or specific datasets.
25     | 
26     |  Methods defined here:
27     | 
28     |  getDurationAndVolume(self, format='NetCDF')
29     |      Returns the estimated duration and volume of the request.
30     | 
31     |  getDurationEstimate(self, format='NetCDF')
32     |      Method to estimate the time it will take to process a request.
33     | 
34     |  getVolumeEstimate(self, format='NetCDF')
35     |      Method to get that the volume of data requested.
36     | 
37     |  localCostingRules(self, estimatedDuration)
38     |      Method to be defined by local extractor administrator. Essentially a
39     |      hook for your local rules and algorithms. It takes in the estimated
40     |      duration and allows you to alter it as you see fit.
41     | 
42     |  ----------------------------------------------------------------------
43     |  Methods inherited from extractMetadata.MetadataExtractor:
44     | 
45     |  OLDOLD_defineTimeDicts(self, dsetNumber)
46     |      Method to define the startTime and endTime dictionaries from the request.
47     | 
48     |  __init__(self, filenames, request)
49     |      __init__ method - requires one or two filenames and a request object
50     |      and sets up instance objects.
51     | 
52     |  getFileList(self)
53     |      Method that returns the list of files associated with a particular
54     |      request. If more than one variable has been selected then the list
55     |      contains a concatenation of allVar1Files+allVar2Files.....+allVarNFiles.
56     | 
57     |  getRequestSizeInBytes(self)
58     |      Method to get the size of the request in bytes.
59     | 
60     |  getTimeStepCount(self)
61     |      Method to return the number of time steps requested.
62     | 
63     |  getTimeSteps(self, dsetNumber=1)
64     |      Method to return a list of tuples for all timesteps requested.
65
Note: See TracBrowser for help on using the repository browser.