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

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

Put all the old code in the old_stuff branch.

  • Property svn:executable set to *
Line 
1Help on module times:
2
3NAME
4    times
5
6FILE
7    /usr/local/dx-0.1.1/times.py
8
9CLASSES
10    DateTime
11        UMTime
12   
13    class DateTime
14     |  Class to return lists of dates and times and allow adding and
15     |  subtracting of time intervals from time objects.
16     | 
17     |  Methods defined here:
18     | 
19     |  __getattr__(self, att)
20     |      ##########################################
21     |      #
22     |      # __getattr__() method
23     |      #
24     |      ##########################################
25     | 
26     |  __init__(self, year=0, month=1, day=1, hour=0, minute=0, second=0)
27     |      Method to set up the instance formats and basic objects.
28     | 
29     |  __repr__(self)
30     |      ##########################################
31     |      #
32     |      # __repr__() method
33     |      #
34     |      ##########################################
35     | 
36     |  __str__(self)
37     |      ##########################################
38     |      #
39     |      # __str__() method
40     |      #
41     |      ##########################################
42     | 
43     |  add(self, n, unit='hour')
44     |      ##########################################
45     |      #
46     |      # add() method
47     |      #
48     |      ##########################################
49     | 
50     |  createList(self, start, end, interval=(6, 'hour'), listtype='string', formatstring='%Y-%m-%d %H:%M:%S')
51     |      ##########################################
52     |      #
53     |      # createList() method
54     |      #
55     |      ##########################################
56     | 
57     |  formatTime(self, formatstring='%Y-%m-%d %H:%M:%S', itime=None)
58     |      ##########################################
59     |      #
60     |      # formatTime() method
61     |      #
62     |      ##########################################
63     | 
64     |  getDaysInMonth(self, month, year)
65     |      ##########################################
66     |      #
67     |      # getDaysInMonth() method
68     |      #
69     |      ##########################################
70     | 
71     |  getTimeBins(self, timelist)
72     |      Method to collect all available values of year, month, day etc into individual
73     |      lists for populating selection boxes.
74     | 
75     |  printtime(self, formatstring='%Y-%m-%d %H:%M:%S', itime=None)
76     |      ##########################################
77     |      #
78     |      # printtime() method
79     |      #
80     |      ##########################################
81     | 
82     |  sub(self, n, unit='hour')
83     |      ##########################################
84     |      #
85     |      # sub() method
86     |      #
87     |      ##########################################
88     | 
89     |  ----------------------------------------------------------------------
90     |  Data and other attributes defined here:
91     | 
92     |  max = [99999, 13, None, 24, 60, 60]
93     | 
94     |  min = [0, 1, 1, 0, 0, 0]
95     | 
96     |  positions = ['year', 'month', 'day', 'hour', 'minute', 'second']
97     | 
98     |  units = {'day': 'd ds dy dys day days', 'hour': 'h hs hr hrs hour hour...
99   
100    class UMTime(DateTime)
101     |  ##############################################
102     |  #
103     |  # class UMTime
104     |  #
105     |  ##############################################
106     | 
107     |  Methods defined here:
108     | 
109     |  __init__(self, year=0, month=1, day=1, hour=0, minute=0, second=0)
110     |      ##########################################
111     |      #
112     |      # __init__() method
113     |      #
114     |      ##########################################
115     | 
116     |  getUMYear(self, itime)
117     |      ##########################################
118     |      #
119     |      # getUMYear() method
120     |      #
121     |      ##########################################
122     | 
123     |  ----------------------------------------------------------------------
124     |  Methods inherited from DateTime:
125     | 
126     |  __getattr__(self, att)
127     |      ##########################################
128     |      #
129     |      # __getattr__() method
130     |      #
131     |      ##########################################
132     | 
133     |  __repr__(self)
134     |      ##########################################
135     |      #
136     |      # __repr__() method
137     |      #
138     |      ##########################################
139     | 
140     |  __str__(self)
141     |      ##########################################
142     |      #
143     |      # __str__() method
144     |      #
145     |      ##########################################
146     | 
147     |  add(self, n, unit='hour')
148     |      ##########################################
149     |      #
150     |      # add() method
151     |      #
152     |      ##########################################
153     | 
154     |  createList(self, start, end, interval=(6, 'hour'), listtype='string', formatstring='%Y-%m-%d %H:%M:%S')
155     |      ##########################################
156     |      #
157     |      # createList() method
158     |      #
159     |      ##########################################
160     | 
161     |  formatTime(self, formatstring='%Y-%m-%d %H:%M:%S', itime=None)
162     |      ##########################################
163     |      #
164     |      # formatTime() method
165     |      #
166     |      ##########################################
167     | 
168     |  getDaysInMonth(self, month, year)
169     |      ##########################################
170     |      #
171     |      # getDaysInMonth() method
172     |      #
173     |      ##########################################
174     | 
175     |  getTimeBins(self, timelist)
176     |      Method to collect all available values of year, month, day etc into individual
177     |      lists for populating selection boxes.
178     | 
179     |  printtime(self, formatstring='%Y-%m-%d %H:%M:%S', itime=None)
180     |      ##########################################
181     |      #
182     |      # printtime() method
183     |      #
184     |      ##########################################
185     | 
186     |  sub(self, n, unit='hour')
187     |      ##########################################
188     |      #
189     |      # sub() method
190     |      #
191     |      ##########################################
192     | 
193     |  ----------------------------------------------------------------------
194     |  Data and other attributes inherited from DateTime:
195     | 
196     |  max = [99999, 13, None, 24, 60, 60]
197     | 
198     |  min = [0, 1, 1, 0, 0, 0]
199     | 
200     |  positions = ['year', 'month', 'day', 'hour', 'minute', 'second']
201     | 
202     |  units = {'day': 'd ds dy dys day days', 'hour': 'h hs hr hrs hour hour...
203
Note: See TracBrowser for help on using the repository browser.