usgs-ruby 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.rubocop.yml +87 -0
- data/CHANGELOG.md +5 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/LICENSE.txt +21 -0
- data/README.md +256 -0
- data/Rakefile +24 -0
- data/docs/Usgs/Client.html +563 -0
- data/docs/Usgs/DailyValues.html +338 -0
- data/docs/Usgs/InstantaneousValues.html +329 -0
- data/docs/Usgs/Models/Reading.html +1124 -0
- data/docs/Usgs/Models/Site.html +2030 -0
- data/docs/Usgs/Models/Statistic.html +3981 -0
- data/docs/Usgs/Models.html +117 -0
- data/docs/Usgs/Parser.html +346 -0
- data/docs/Usgs/Parsers/RdbParser.html +354 -0
- data/docs/Usgs/Parsers/SiteParser.html +174 -0
- data/docs/Usgs/Parsers/StatisticsParser.html +228 -0
- data/docs/Usgs/Parsers/TimeSeriesParser.html +189 -0
- data/docs/Usgs/Parsers.html +117 -0
- data/docs/Usgs/Site.html +445 -0
- data/docs/Usgs/Statistics.html +335 -0
- data/docs/Usgs/Utils.html +357 -0
- data/docs/Usgs.html +303 -0
- data/docs/_index.html +286 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/file.README.html +111 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +111 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +598 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/usgs/client.rb +62 -0
- data/lib/usgs/daily_values.rb +38 -0
- data/lib/usgs/instantaneous_values.rb +35 -0
- data/lib/usgs/models/reading.rb +43 -0
- data/lib/usgs/models/site.rb +61 -0
- data/lib/usgs/models/statistic.rb +95 -0
- data/lib/usgs/parser.rb +23 -0
- data/lib/usgs/parsers/rdb_parser.rb +55 -0
- data/lib/usgs/parsers/site_parser.rb +13 -0
- data/lib/usgs/parsers/statistics_parser.rb +40 -0
- data/lib/usgs/parsers/time_series_parser.rb +54 -0
- data/lib/usgs/site.rb +50 -0
- data/lib/usgs/statistics.rb +42 -0
- data/lib/usgs/utils.rb +50 -0
- data/lib/usgs/version.rb +5 -0
- data/lib/usgs.rb +28 -0
- data/sig/usgs/ruby.rbs +6 -0
- data/usgs-ruby.gemspec +48 -0
- metadata +231 -0
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: Usgs::Utils
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Usgs::Utils";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (U)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Usgs.html" title="Usgs (module)">Usgs</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Utils</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: Usgs::Utils
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="DailyValues.html" title="Usgs::DailyValues (module)">DailyValues</a></span>, <span class='object_link'><a href="InstantaneousValues.html" title="Usgs::InstantaneousValues (module)">InstantaneousValues</a></span>, <span class='object_link'><a href="Site.html" title="Usgs::Site (module)">Site</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/usgs/utils.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
|
|
94
|
+
<p>Provides utility methods for handling dates, query parameters, and API pagination.</p>
|
|
95
|
+
|
|
96
|
+
<p>This module contains helper methods used across the CDSS API client for data formatting, safe type conversion, and managing paginated responses.</p>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
<div class="tags">
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<h2>
|
|
113
|
+
Instance Method Summary
|
|
114
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
115
|
+
</h2>
|
|
116
|
+
|
|
117
|
+
<ul class="summary">
|
|
118
|
+
|
|
119
|
+
<li class="public ">
|
|
120
|
+
<span class="summary_signature">
|
|
121
|
+
|
|
122
|
+
<a href="#format_date-instance_method" title="#format_date (instance method)">#<strong>format_date</strong>(date) ⇒ Object </a>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</span>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
137
|
+
|
|
138
|
+
</li>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#format_datetime-instance_method" title="#format_datetime (instance method)">#<strong>format_datetime</strong>(dt) ⇒ Object </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
159
|
+
|
|
160
|
+
</li>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#resolve_parameter_codes-instance_method" title="#resolve_parameter_codes (instance method)">#<strong>resolve_parameter_codes</strong>(codes) ⇒ Object </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<span class="summary_desc"><div class='inline'>
|
|
181
|
+
<p>Convert symbols to official USGS parameter codes.</p>
|
|
182
|
+
</div></span>
|
|
183
|
+
|
|
184
|
+
</li>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</ul>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<div id="instance_method_details" class="method_details_list">
|
|
193
|
+
<h2>Instance Method Details</h2>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<div class="method_details first">
|
|
197
|
+
<h3 class="signature first" id="format_date-instance_method">
|
|
198
|
+
|
|
199
|
+
#<strong>format_date</strong>(date) ⇒ <tt>Object</tt>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</h3><table class="source_code">
|
|
206
|
+
<tr>
|
|
207
|
+
<td>
|
|
208
|
+
<pre class="lines">
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
35
|
|
212
|
+
36
|
|
213
|
+
37
|
|
214
|
+
38
|
|
215
|
+
39</pre>
|
|
216
|
+
</td>
|
|
217
|
+
<td>
|
|
218
|
+
<pre class="code"><span class="info file"># File 'lib/usgs/utils.rb', line 35</span>
|
|
219
|
+
|
|
220
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span>
|
|
221
|
+
<span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%Y-%m-%d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
222
|
+
<span class='kw'>rescue</span>
|
|
223
|
+
<span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%Y-%m-%d</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
224
|
+
<span class='kw'>end</span></pre>
|
|
225
|
+
</td>
|
|
226
|
+
</tr>
|
|
227
|
+
</table>
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
<div class="method_details ">
|
|
231
|
+
<h3 class="signature " id="format_datetime-instance_method">
|
|
232
|
+
|
|
233
|
+
#<strong>format_datetime</strong>(dt) ⇒ <tt>Object</tt>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</h3><table class="source_code">
|
|
240
|
+
<tr>
|
|
241
|
+
<td>
|
|
242
|
+
<pre class="lines">
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
41
|
|
246
|
+
42
|
|
247
|
+
43
|
|
248
|
+
44</pre>
|
|
249
|
+
</td>
|
|
250
|
+
<td>
|
|
251
|
+
<pre class="code"><span class="info file"># File 'lib/usgs/utils.rb', line 41</span>
|
|
252
|
+
|
|
253
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_datetime'>format_datetime</span><span class='lparen'>(</span><span class='id identifier rubyid_dt'>dt</span><span class='rparen'>)</span>
|
|
254
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_dt'>dt</span>
|
|
255
|
+
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_dt'>dt</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_utc'>utc</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%Y-%m-%dT%H:%M</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
256
|
+
<span class='kw'>end</span></pre>
|
|
257
|
+
</td>
|
|
258
|
+
</tr>
|
|
259
|
+
</table>
|
|
260
|
+
</div>
|
|
261
|
+
|
|
262
|
+
<div class="method_details ">
|
|
263
|
+
<h3 class="signature " id="resolve_parameter_codes-instance_method">
|
|
264
|
+
|
|
265
|
+
#<strong>resolve_parameter_codes</strong>(codes) ⇒ <tt>Object</tt>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</h3><div class="docstring">
|
|
272
|
+
<div class="discussion">
|
|
273
|
+
|
|
274
|
+
<p>Convert symbols to official USGS parameter codes</p>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</div>
|
|
278
|
+
</div>
|
|
279
|
+
<div class="tags">
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</div><table class="source_code">
|
|
283
|
+
<tr>
|
|
284
|
+
<td>
|
|
285
|
+
<pre class="lines">
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
10
|
|
289
|
+
11
|
|
290
|
+
12
|
|
291
|
+
13
|
|
292
|
+
14
|
|
293
|
+
15
|
|
294
|
+
16
|
|
295
|
+
17
|
|
296
|
+
18
|
|
297
|
+
19
|
|
298
|
+
20
|
|
299
|
+
21
|
|
300
|
+
22
|
|
301
|
+
23
|
|
302
|
+
24
|
|
303
|
+
25
|
|
304
|
+
26
|
|
305
|
+
27
|
|
306
|
+
28
|
|
307
|
+
29
|
|
308
|
+
30
|
|
309
|
+
31
|
|
310
|
+
32
|
|
311
|
+
33</pre>
|
|
312
|
+
</td>
|
|
313
|
+
<td>
|
|
314
|
+
<pre class="code"><span class="info file"># File 'lib/usgs/utils.rb', line 10</span>
|
|
315
|
+
|
|
316
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resolve_parameter_codes'>resolve_parameter_codes</span><span class='lparen'>(</span><span class='id identifier rubyid_codes'>codes</span><span class='rparen'>)</span>
|
|
317
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_codes'>codes</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
318
|
+
|
|
319
|
+
<span class='id identifier rubyid_mapping'>mapping</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
320
|
+
<span class='label'>discharge:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00060</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
321
|
+
<span class='label'>gage_height:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00065</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
322
|
+
<span class='label'>temperature:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00010</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
323
|
+
<span class='label'>precipitation:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00045</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
324
|
+
<span class='label'>do:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00300</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
325
|
+
<span class='label'>conductivity:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00095</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
326
|
+
<span class='label'>ph:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00400</span><span class='tstring_end'>"</span></span>
|
|
327
|
+
<span class='rbrace'>}</span>
|
|
328
|
+
|
|
329
|
+
<span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_codes'>codes</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
|
|
330
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
|
|
331
|
+
<span class='id identifier rubyid_mapped'>mapped</span> <span class='op'>=</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='lbracket'>[</span><span class='id identifier rubyid_c'>c</span><span class='rbracket'>]</span>
|
|
332
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid parameter code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_c'>c</span><span class='embexpr_end'>}</span><span class='tstring_content'>. Valid codes are: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_mapping'>mapping</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_mapped'>mapped</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
333
|
+
|
|
334
|
+
<span class='id identifier rubyid_mapped'>mapped</span>
|
|
335
|
+
<span class='kw'>else</span>
|
|
336
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
337
|
+
<span class='kw'>end</span>
|
|
338
|
+
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
339
|
+
<span class='kw'>end</span></pre>
|
|
340
|
+
</td>
|
|
341
|
+
</tr>
|
|
342
|
+
</table>
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
<div id="footer">
|
|
350
|
+
Generated on Mon Dec 15 21:52:18 2025 by
|
|
351
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
352
|
+
0.9.37 (ruby-3.2.2).
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
</div>
|
|
356
|
+
</body>
|
|
357
|
+
</html>
|
data/docs/Usgs.html
ADDED
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: Usgs
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Usgs";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (U)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Usgs</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: Usgs
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<dl>
|
|
73
|
+
<dt>Extended by:</dt>
|
|
74
|
+
<dd>Dry::Configurable</dd>
|
|
75
|
+
</dl>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/usgs/daily_values.rb<span class="defines">,<br />
|
|
87
|
+
lib/usgs.rb,<br /> lib/usgs/site.rb,<br /> lib/usgs/utils.rb,<br /> lib/usgs/client.rb,<br /> lib/usgs/parser.rb,<br /> lib/usgs/version.rb,<br /> lib/usgs/statistics.rb,<br /> lib/usgs/models/site.rb,<br /> lib/usgs/models/reading.rb,<br /> lib/usgs/models/statistic.rb,<br /> lib/usgs/parsers/rdb_parser.rb,<br /> lib/usgs/parsers/site_parser.rb,<br /> lib/usgs/instantaneous_values.rb,<br /> lib/usgs/parsers/statistics_parser.rb,<br /> lib/usgs/parsers/time_series_parser.rb</span>
|
|
88
|
+
</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>lib/usgs/daily_values.rb frozen_string_literal: true</p>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
<div class="tags">
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</div><h2>Defined Under Namespace</h2>
|
|
105
|
+
<p class="children">
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Usgs/DailyValues.html" title="Usgs::DailyValues (module)">DailyValues</a></span>, <span class='object_link'><a href="Usgs/InstantaneousValues.html" title="Usgs::InstantaneousValues (module)">InstantaneousValues</a></span>, <span class='object_link'><a href="Usgs/Models.html" title="Usgs::Models (module)">Models</a></span>, <span class='object_link'><a href="Usgs/Parsers.html" title="Usgs::Parsers (module)">Parsers</a></span>, <span class='object_link'><a href="Usgs/Site.html" title="Usgs::Site (module)">Site</a></span>, <span class='object_link'><a href="Usgs/Statistics.html" title="Usgs::Statistics (module)">Statistics</a></span>, <span class='object_link'><a href="Usgs/Utils.html" title="Usgs::Utils (module)">Utils</a></span>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Usgs/Client.html" title="Usgs::Client (class)">Client</a></span>, <span class='object_link'><a href="Usgs/Parser.html" title="Usgs::Parser (class)">Parser</a></span>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h2>
|
|
119
|
+
Constant Summary
|
|
120
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
121
|
+
</h2>
|
|
122
|
+
|
|
123
|
+
<dl class="constants">
|
|
124
|
+
|
|
125
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
126
|
+
|
|
127
|
+
</dt>
|
|
128
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
129
|
+
|
|
130
|
+
</dl>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
137
|
+
<ul class="summary">
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#loader-class_method" title="loader (class method)">.<strong>loader</strong> ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<span class="note title readonly">readonly</span>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<span class="summary_desc"><div class='inline'>
|
|
162
|
+
<p>Returns the value of attribute loader.</p>
|
|
163
|
+
</div></span>
|
|
164
|
+
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</ul>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<h2>
|
|
175
|
+
Class Method Summary
|
|
176
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
177
|
+
</h2>
|
|
178
|
+
|
|
179
|
+
<ul class="summary">
|
|
180
|
+
|
|
181
|
+
<li class="public ">
|
|
182
|
+
<span class="summary_signature">
|
|
183
|
+
|
|
184
|
+
<a href="#client-class_method" title="client (class method)">.<strong>client</strong>(**options) ⇒ Object </a>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</ul>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<div id="class_attr_details" class="attr_details">
|
|
209
|
+
<h2>Class Attribute Details</h2>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span id=""></span>
|
|
213
|
+
<div class="method_details first">
|
|
214
|
+
<h3 class="signature first" id="loader-class_method">
|
|
215
|
+
|
|
216
|
+
.<strong>loader</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</h3><div class="docstring">
|
|
223
|
+
<div class="discussion">
|
|
224
|
+
|
|
225
|
+
<p>Returns the value of attribute loader.</p>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
</div>
|
|
230
|
+
<div class="tags">
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
</div><table class="source_code">
|
|
234
|
+
<tr>
|
|
235
|
+
<td>
|
|
236
|
+
<pre class="lines">
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
23
|
|
240
|
+
24
|
|
241
|
+
25</pre>
|
|
242
|
+
</td>
|
|
243
|
+
<td>
|
|
244
|
+
<pre class="code"><span class="info file"># File 'lib/usgs.rb', line 23</span>
|
|
245
|
+
|
|
246
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_loader'>loader</span>
|
|
247
|
+
<span class='ivar'>@loader</span>
|
|
248
|
+
<span class='kw'>end</span></pre>
|
|
249
|
+
</td>
|
|
250
|
+
</tr>
|
|
251
|
+
</table>
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<div id="class_method_details" class="method_details_list">
|
|
258
|
+
<h2>Class Method Details</h2>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<div class="method_details first">
|
|
262
|
+
<h3 class="signature first" id="client-class_method">
|
|
263
|
+
|
|
264
|
+
.<strong>client</strong>(**options) ⇒ <tt>Object</tt>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</h3><table class="source_code">
|
|
271
|
+
<tr>
|
|
272
|
+
<td>
|
|
273
|
+
<pre class="lines">
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
25
|
|
277
|
+
26
|
|
278
|
+
27</pre>
|
|
279
|
+
</td>
|
|
280
|
+
<td>
|
|
281
|
+
<pre class="code"><span class="info file"># File 'lib/usgs.rb', line 25</span>
|
|
282
|
+
|
|
283
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
284
|
+
<span class='const'><span class='object_link'><a href="" title="Usgs (module)">Usgs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Usgs/Client.html" title="Usgs::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Usgs/Client.html#initialize-instance_method" title="Usgs::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
285
|
+
<span class='kw'>end</span></pre>
|
|
286
|
+
</td>
|
|
287
|
+
</tr>
|
|
288
|
+
</table>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
<div id="footer">
|
|
296
|
+
Generated on Mon Dec 15 21:52:18 2025 by
|
|
297
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
298
|
+
0.9.37 (ruby-3.2.2).
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
</div>
|
|
302
|
+
</body>
|
|
303
|
+
</html>
|