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

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

Put all the old code in the old_stuff branch.

Line 
1Help on module datasetdb:
2
3NAME
4    datasetdb
5
6FILE
7    /usr/local/dx-0.1.1/datasetdb.py
8
9DESCRIPTION
10    datasets.py
11    ===========
12   
13    Datasets module for the dx package.
14   
15    This module holds the Datasetdb class that is used
16    to hold and access information about datasets visible
17    to the dx package.
18
19CLASSES
20    Datasetdb
21   
22    class Datasetdb
23     |  Datasetdb class - a group of methods to connect to a dataset group or
24     |  dataset to extract information about the contents.
25     | 
26     |  Methods defined here:
27     | 
28     |  __init__(self)
29     |      __init__ method - set up instance variables.
30     | 
31     |  getCFGlobalAttributes(self, datafile)
32     |      getCFGlobalAttributes method - gets any CF metadta global attributes that are available
33     |      from the source dataset/file.
34     | 
35     |  getDatasetGroupFromURI(self, datasetURI)
36     |      getDatasetGroupFromURI method - gets the id of the dataset group from a
37     |      datasetURI (if it is known to the dx).
38     | 
39     |  getDatasetGroups(self)
40     |      getDatasetGroups method - returns the dataset groups that the dx knows about.
41     | 
42     |  getDatasetURIList(self)
43     |      getDatasetURILList method - gets a list of all the datasetURIs visible
44     |      to this version of dx (in the config.py file).
45     | 
46     |  getDatasets(self, datasetGroup)
47     |      getDatasets method - returns the datasets associated with the dataset group
48     |      argument.
49     | 
50     |  getDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
51     |      getDomain method - returns the combined horizontal, vertical and temporal domains.
52     | 
53     |  getHorizontalSpatialDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
54     | 
55     |  getProtectID(datasetGroup=None, datasetURI=None)
56     |      getProtectID method - returns the security group for a given dataset group or
57     |      datasetURI (if known to the dx).
58     | 
59     |  getTemporalDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
60     |      getTemporalDomain method - returns the temporal domain as a tuple of (start time, end time,
61     |      (interval value, interval units)).
62     | 
63     |  getVariables(self, datasetGroup=None, dataset=None, datasetURI=None)
64     |      getVariables method - returns a list of variables ior the given dataset
65     |      group/dataset combination or datasetURI. The variable name used is selected
66     |      hierarchically depending on the available attributes.
67     | 
68     |  getVerticalSpatialDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
69     |      getVerticalSpatialDomain method - returns the vertical domain as a tuple containing
70     |      a list of levels (or "Single level" string) and the units.
71
Note: See TracBrowser for help on using the repository browser.