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

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

Put all the old code in the old_stuff branch.

RevLine 
[793]1####################################################
2WARNING: I DON'T KNOW ABOUT MULTIPLE DATASETS IN ONE FILE IN TERMS
3OF MIXING THE SOURCE FIELDS IN THE TEMPLATE!!!!
4We should ask the users if they like the file-naming convention when they download!!
5Help on module fileNames:
6
7NAME
8    fileNames
9
10FILE
11    /usr/local/dx-0.1.1/fileNames.py
12
13DESCRIPTION
14    fileNames.py
15    ============
16   
17    Contains the FileNames class used to define output file names based
18    on the data content of files and rules defined externally.
19
20CLASSES
21    FileNames
22   
23    class FileNames
24     |  Class to define output file names based on the contents of a data file.
25     |  The default is to create one output file per time step.
26     | 
27     |  Methods defined here:
28     | 
29     |  __init__(self, datasetGroup=None, dataset=None, timeSteps=None, horizontalBounds=None, verticalDomain=None, variables=None, fileFormat=None)
30     |      Method to set up instance variables and call instance methods.
31     | 
32     |  createFileNameList(self)
33     |      Method to generate a list of file names based in the template defined
34     |      by this class. Should this be implemented to take both a list of date/times and
35     |      a start, end and interval?
36
Note: See TracBrowser for help on using the repository browser.