cdss-ruby 0.1.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 +86 -0
- data/CHANGELOG.md +5 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/README.md +101 -0
- data/Rakefile +26 -0
- data/docs/Cdss/AdminCalls.html +399 -0
- data/docs/Cdss/Analysis.html +972 -0
- data/docs/Cdss/Client.html +581 -0
- data/docs/Cdss/Climate.html +1257 -0
- data/docs/Cdss/Concerns/LogReadingAttributes.html +406 -0
- data/docs/Cdss/Concerns/WellReadingAttributes.html +414 -0
- data/docs/Cdss/Concerns.html +117 -0
- data/docs/Cdss/GroundWater.html +945 -0
- data/docs/Cdss/Models/AdminCall.html +252 -0
- data/docs/Cdss/Models/Analysis.html +397 -0
- data/docs/Cdss/Models/CallAnalysis.html +140 -0
- data/docs/Cdss/Models/ClimateStation.html +249 -0
- data/docs/Cdss/Models/DiversionRecord.html +248 -0
- data/docs/Cdss/Models/Reading.html +301 -0
- data/docs/Cdss/Models/ReferenceTable.html +339 -0
- data/docs/Cdss/Models/RouteAnalysis.html +140 -0
- data/docs/Cdss/Models/SourceRoute.html +140 -0
- data/docs/Cdss/Models/Station.html +248 -0
- data/docs/Cdss/Models/Structure.html +259 -0
- data/docs/Cdss/Models/WaterClass.html +249 -0
- data/docs/Cdss/Models/WaterRight.html +255 -0
- data/docs/Cdss/Models/Well.html +251 -0
- data/docs/Cdss/Models.html +117 -0
- data/docs/Cdss/Parser.html +2155 -0
- data/docs/Cdss/Parsers/AdminCallsParser.html +201 -0
- data/docs/Cdss/Parsers/AnalysisParser.html +296 -0
- data/docs/Cdss/Parsers/BaseParser.html +207 -0
- data/docs/Cdss/Parsers/ClimateParser.html +253 -0
- data/docs/Cdss/Parsers/ReadingParser.html +201 -0
- data/docs/Cdss/Parsers/ReferenceTablesParser.html +201 -0
- data/docs/Cdss/Parsers/StationParser.html +201 -0
- data/docs/Cdss/Parsers/StructuresParser.html +305 -0
- data/docs/Cdss/Parsers/WaterRightsParser.html +219 -0
- data/docs/Cdss/Parsers/WellParser.html +357 -0
- data/docs/Cdss/Parsers.html +117 -0
- data/docs/Cdss/ReferenceTables.html +332 -0
- data/docs/Cdss/Structures.html +1132 -0
- data/docs/Cdss/SurfaceWater.html +798 -0
- data/docs/Cdss/Telemetry.html +763 -0
- data/docs/Cdss/Utils.html +1276 -0
- data/docs/Cdss/WaterRights.html +634 -0
- data/docs/Cdss.html +292 -0
- data/docs/_index.html +493 -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 +108 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +108 -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 +790 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/cdss/admin_calls.rb +44 -0
- data/lib/cdss/analysis.rb +183 -0
- data/lib/cdss/client.rb +121 -0
- data/lib/cdss/climate.rb +155 -0
- data/lib/cdss/concerns/log_reading_attributes.rb +48 -0
- data/lib/cdss/concerns/well_reading_attributes.rb +56 -0
- data/lib/cdss/ground_water.rb +112 -0
- data/lib/cdss/models/admin_call.rb +45 -0
- data/lib/cdss/models/analysis.rb +77 -0
- data/lib/cdss/models/climate_station.rb +40 -0
- data/lib/cdss/models/reading.rb +54 -0
- data/lib/cdss/models/reference_table.rb +56 -0
- data/lib/cdss/models/station.rb +40 -0
- data/lib/cdss/models/structure.rb +101 -0
- data/lib/cdss/models/water_right.rb +47 -0
- data/lib/cdss/models/well.rb +43 -0
- data/lib/cdss/parser.rb +172 -0
- data/lib/cdss/parsers/admin_calls_parser.rb +47 -0
- data/lib/cdss/parsers/analysis_parser.rb +124 -0
- data/lib/cdss/parsers/base_parser.rb +18 -0
- data/lib/cdss/parsers/climate_parser.rb +86 -0
- data/lib/cdss/parsers/reading_parser.rb +90 -0
- data/lib/cdss/parsers/reference_tables_parser.rb +55 -0
- data/lib/cdss/parsers/station_parser.rb +42 -0
- data/lib/cdss/parsers/structures_parser.rb +96 -0
- data/lib/cdss/parsers/water_rights_parser.rb +77 -0
- data/lib/cdss/parsers/well_parser.rb +107 -0
- data/lib/cdss/reference_tables.rb +147 -0
- data/lib/cdss/structures.rb +235 -0
- data/lib/cdss/surface_water.rb +186 -0
- data/lib/cdss/telemetry.rb +98 -0
- data/lib/cdss/utils.rb +152 -0
- data/lib/cdss/version.rb +5 -0
- data/lib/cdss/water_rights.rb +95 -0
- data/lib/cdss.rb +27 -0
- data/sig/cdss/ruby.rbs +6 -0
- metadata +272 -0
@@ -0,0 +1,1132 @@
|
|
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: Cdss::Structures
|
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 = "Cdss::Structures";
|
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 (S)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Cdss.html" title="Cdss (module)">Cdss</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Structures</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: Cdss::Structures
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<dl>
|
75
|
+
<dt>Includes:</dt>
|
76
|
+
<dd><span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></dd>
|
77
|
+
</dl>
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
<dl>
|
83
|
+
<dt>Included in:</dt>
|
84
|
+
<dd><span class='object_link'><a href="Client.html" title="Cdss::Client (class)">Client</a></span></dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dl>
|
90
|
+
<dt>Defined in:</dt>
|
91
|
+
<dd>lib/cdss/structures.rb</dd>
|
92
|
+
</dl>
|
93
|
+
|
94
|
+
</div>
|
95
|
+
|
96
|
+
<h2>Overview</h2><div class="docstring">
|
97
|
+
<div class="discussion">
|
98
|
+
|
99
|
+
<p>Provides methods for accessing water structures data from the CDSS API.</p>
|
100
|
+
|
101
|
+
<p>This module includes functionality for retrieving water structures, diversion records, stage/volume data, and water classes.</p>
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
</div>
|
106
|
+
<div class="tags">
|
107
|
+
|
108
|
+
|
109
|
+
</div>
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<h2>
|
118
|
+
Instance Method Summary
|
119
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
120
|
+
</h2>
|
121
|
+
|
122
|
+
<ul class="summary">
|
123
|
+
|
124
|
+
<li class="public ">
|
125
|
+
<span class="summary_signature">
|
126
|
+
|
127
|
+
<a href="#get_diversion_records_ts-instance_method" title="#get_diversion_records_ts (instance method)">#<strong>get_diversion_records_ts</strong>(wdid:, wc_identifier: nil, start_date: nil, end_date: nil, timescale: "day") ⇒ Array<Models::DiversionRecord> </a>
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
</span>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<span class="summary_desc"><div class='inline'>
|
142
|
+
<p>Fetches diversion records time series data.</p>
|
143
|
+
</div></span>
|
144
|
+
|
145
|
+
</li>
|
146
|
+
|
147
|
+
|
148
|
+
<li class="public ">
|
149
|
+
<span class="summary_signature">
|
150
|
+
|
151
|
+
<a href="#get_stage_volume_ts-instance_method" title="#get_stage_volume_ts (instance method)">#<strong>get_stage_volume_ts</strong>(wdid:, start_date: nil, end_date: nil) ⇒ Array<Models::DiversionRecord> </a>
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
</span>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
<span class="summary_desc"><div class='inline'>
|
166
|
+
<p>Fetches stage/volume record data.</p>
|
167
|
+
</div></span>
|
168
|
+
|
169
|
+
</li>
|
170
|
+
|
171
|
+
|
172
|
+
<li class="public ">
|
173
|
+
<span class="summary_signature">
|
174
|
+
|
175
|
+
<a href="#get_structures-instance_method" title="#get_structures (instance method)">#<strong>get_structures</strong>(aoi: nil, radius: nil, county: nil, division: nil, gnis_id: nil, water_district: nil, wdid: nil) ⇒ Array<Models::Structure> </a>
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
</span>
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
<span class="summary_desc"><div class='inline'>
|
190
|
+
<p>Fetches a list of administrative structures based on various filtering criteria.</p>
|
191
|
+
</div></span>
|
192
|
+
|
193
|
+
</li>
|
194
|
+
|
195
|
+
|
196
|
+
<li class="public ">
|
197
|
+
<span class="summary_signature">
|
198
|
+
|
199
|
+
<a href="#get_water_classes-instance_method" title="#get_water_classes (instance method)">#<strong>get_water_classes</strong>(**params) ⇒ Array<Models::WaterClass> </a>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
</span>
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
<span class="summary_desc"><div class='inline'>
|
214
|
+
<p>Fetches water classes for structures.</p>
|
215
|
+
</div></span>
|
216
|
+
|
217
|
+
</li>
|
218
|
+
|
219
|
+
|
220
|
+
</ul>
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
|
233
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#batch_dates-instance_method" title="Cdss::Utils#batch_dates (method)">#batch_dates</a></span>, <span class='object_link'><a href="Utils.html#build_query-instance_method" title="Cdss::Utils#build_query (method)">#build_query</a></span>, <span class='object_link'><a href="Utils.html#fetch_paginated_data-instance_method" title="Cdss::Utils#fetch_paginated_data (method)">#fetch_paginated_data</a></span>, <span class='object_link'><a href="Utils.html#format_date-instance_method" title="Cdss::Utils#format_date (method)">#format_date</a></span>, <span class='object_link'><a href="Utils.html#format_query_param-instance_method" title="Cdss::Utils#format_query_param (method)">#format_query_param</a></span>, <span class='object_link'><a href="Utils.html#parse_timestamp-instance_method" title="Cdss::Utils#parse_timestamp (method)">#parse_timestamp</a></span>, <span class='object_link'><a href="Utils.html#safe_float-instance_method" title="Cdss::Utils#safe_float (method)">#safe_float</a></span>, <span class='object_link'><a href="Utils.html#safe_integer-instance_method" title="Cdss::Utils#safe_integer (method)">#safe_integer</a></span></p>
|
234
|
+
|
235
|
+
|
236
|
+
<div id="instance_method_details" class="method_details_list">
|
237
|
+
<h2>Instance Method Details</h2>
|
238
|
+
|
239
|
+
|
240
|
+
<div class="method_details first">
|
241
|
+
<h3 class="signature first" id="get_diversion_records_ts-instance_method">
|
242
|
+
|
243
|
+
#<strong>get_diversion_records_ts</strong>(wdid:, wc_identifier: nil, start_date: nil, end_date: nil, timescale: "day") ⇒ <tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Models::DiversionRecord</a></span>></tt>
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
</h3><div class="docstring">
|
250
|
+
<div class="discussion">
|
251
|
+
|
252
|
+
<p>Fetches diversion records time series data.</p>
|
253
|
+
|
254
|
+
|
255
|
+
</div>
|
256
|
+
</div>
|
257
|
+
<div class="tags">
|
258
|
+
<p class="tag_title">Parameters:</p>
|
259
|
+
<ul class="param">
|
260
|
+
|
261
|
+
<li>
|
262
|
+
|
263
|
+
<span class='name'>wdid</span>
|
264
|
+
|
265
|
+
|
266
|
+
<span class='type'>(<tt>String</tt>, <tt>Array<String></tt>)</span>
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
—
|
271
|
+
<div class='inline'>
|
272
|
+
<p>WDID code(s) of structures.</p>
|
273
|
+
</div>
|
274
|
+
|
275
|
+
</li>
|
276
|
+
|
277
|
+
<li>
|
278
|
+
|
279
|
+
<span class='name'>wc_identifier</span>
|
280
|
+
|
281
|
+
|
282
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
283
|
+
|
284
|
+
|
285
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
286
|
+
|
287
|
+
|
288
|
+
—
|
289
|
+
<div class='inline'>
|
290
|
+
<p>Water class identifier.</p>
|
291
|
+
</div>
|
292
|
+
|
293
|
+
</li>
|
294
|
+
|
295
|
+
<li>
|
296
|
+
|
297
|
+
<span class='name'>start_date</span>
|
298
|
+
|
299
|
+
|
300
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
301
|
+
|
302
|
+
|
303
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
304
|
+
|
305
|
+
|
306
|
+
—
|
307
|
+
<div class='inline'>
|
308
|
+
<p>Start date for time series data.</p>
|
309
|
+
</div>
|
310
|
+
|
311
|
+
</li>
|
312
|
+
|
313
|
+
<li>
|
314
|
+
|
315
|
+
<span class='name'>end_date</span>
|
316
|
+
|
317
|
+
|
318
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
319
|
+
|
320
|
+
|
321
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
322
|
+
|
323
|
+
|
324
|
+
—
|
325
|
+
<div class='inline'>
|
326
|
+
<p>End date for time series data.</p>
|
327
|
+
</div>
|
328
|
+
|
329
|
+
</li>
|
330
|
+
|
331
|
+
<li>
|
332
|
+
|
333
|
+
<span class='name'>timescale</span>
|
334
|
+
|
335
|
+
|
336
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
337
|
+
|
338
|
+
|
339
|
+
<em class="default">(defaults to: <tt>"day"</tt>)</em>
|
340
|
+
|
341
|
+
|
342
|
+
—
|
343
|
+
<div class='inline'>
|
344
|
+
<p>Time interval (‘day’, ‘month’, or ‘year’). Defaults to ‘day’.</p>
|
345
|
+
</div>
|
346
|
+
|
347
|
+
</li>
|
348
|
+
|
349
|
+
</ul>
|
350
|
+
|
351
|
+
<p class="tag_title">Returns:</p>
|
352
|
+
<ul class="return">
|
353
|
+
|
354
|
+
<li>
|
355
|
+
|
356
|
+
|
357
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Models::DiversionRecord</a></span>></tt>)</span>
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
—
|
362
|
+
<div class='inline'>
|
363
|
+
<p>Array of diversion records.</p>
|
364
|
+
</div>
|
365
|
+
|
366
|
+
</li>
|
367
|
+
|
368
|
+
</ul>
|
369
|
+
<p class="tag_title">Raises:</p>
|
370
|
+
<ul class="raise">
|
371
|
+
|
372
|
+
<li>
|
373
|
+
|
374
|
+
|
375
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
—
|
380
|
+
<div class='inline'>
|
381
|
+
<p>If an invalid timescale is provided.</p>
|
382
|
+
</div>
|
383
|
+
|
384
|
+
</li>
|
385
|
+
|
386
|
+
</ul>
|
387
|
+
|
388
|
+
</div><table class="source_code">
|
389
|
+
<tr>
|
390
|
+
<td>
|
391
|
+
<pre class="lines">
|
392
|
+
|
393
|
+
|
394
|
+
58
|
395
|
+
59
|
396
|
+
60
|
397
|
+
61
|
398
|
+
62
|
399
|
+
63</pre>
|
400
|
+
</td>
|
401
|
+
<td>
|
402
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/structures.rb', line 58</span>
|
403
|
+
|
404
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_diversion_records_ts'>get_diversion_records_ts</span><span class='lparen'>(</span><span class='label'>wdid:</span><span class='comma'>,</span> <span class='label'>wc_identifier:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>timescale:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>day</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
405
|
+
<span class='id identifier rubyid_validate_timescale!'>validate_timescale!</span><span class='lparen'>(</span><span class='id identifier rubyid_timescale'>timescale</span><span class='rparen'>)</span>
|
406
|
+
|
407
|
+
<span class='id identifier rubyid_method_name'>method_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>fetch_diversion_records_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_timescale'>timescale</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
408
|
+
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method_name'>method_name</span><span class='comma'>,</span> <span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span><span class='comma'>,</span> <span class='label'>wc_identifier:</span> <span class='id identifier rubyid_wc_identifier'>wc_identifier</span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='id identifier rubyid_start_date'>start_date</span><span class='comma'>,</span> <span class='label'>end_date:</span> <span class='id identifier rubyid_end_date'>end_date</span><span class='rparen'>)</span>
|
409
|
+
<span class='kw'>end</span></pre>
|
410
|
+
</td>
|
411
|
+
</tr>
|
412
|
+
</table>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
<div class="method_details ">
|
416
|
+
<h3 class="signature " id="get_stage_volume_ts-instance_method">
|
417
|
+
|
418
|
+
#<strong>get_stage_volume_ts</strong>(wdid:, start_date: nil, end_date: nil) ⇒ <tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Models::DiversionRecord</a></span>></tt>
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
</h3><div class="docstring">
|
425
|
+
<div class="discussion">
|
426
|
+
|
427
|
+
<p>Fetches stage/volume record data.</p>
|
428
|
+
|
429
|
+
|
430
|
+
</div>
|
431
|
+
</div>
|
432
|
+
<div class="tags">
|
433
|
+
<p class="tag_title">Parameters:</p>
|
434
|
+
<ul class="param">
|
435
|
+
|
436
|
+
<li>
|
437
|
+
|
438
|
+
<span class='name'>wdid</span>
|
439
|
+
|
440
|
+
|
441
|
+
<span class='type'>(<tt>String</tt>)</span>
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
—
|
446
|
+
<div class='inline'>
|
447
|
+
<p>WDID code of structure.</p>
|
448
|
+
</div>
|
449
|
+
|
450
|
+
</li>
|
451
|
+
|
452
|
+
<li>
|
453
|
+
|
454
|
+
<span class='name'>start_date</span>
|
455
|
+
|
456
|
+
|
457
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
458
|
+
|
459
|
+
|
460
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
461
|
+
|
462
|
+
|
463
|
+
—
|
464
|
+
<div class='inline'>
|
465
|
+
<p>Start date for records.</p>
|
466
|
+
</div>
|
467
|
+
|
468
|
+
</li>
|
469
|
+
|
470
|
+
<li>
|
471
|
+
|
472
|
+
<span class='name'>end_date</span>
|
473
|
+
|
474
|
+
|
475
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
476
|
+
|
477
|
+
|
478
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
479
|
+
|
480
|
+
|
481
|
+
—
|
482
|
+
<div class='inline'>
|
483
|
+
<p>End date for records.</p>
|
484
|
+
</div>
|
485
|
+
|
486
|
+
</li>
|
487
|
+
|
488
|
+
</ul>
|
489
|
+
|
490
|
+
<p class="tag_title">Returns:</p>
|
491
|
+
<ul class="return">
|
492
|
+
|
493
|
+
<li>
|
494
|
+
|
495
|
+
|
496
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Models::DiversionRecord</a></span>></tt>)</span>
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
—
|
501
|
+
<div class='inline'>
|
502
|
+
<p>Array of stage/volume records.</p>
|
503
|
+
</div>
|
504
|
+
|
505
|
+
</li>
|
506
|
+
|
507
|
+
</ul>
|
508
|
+
|
509
|
+
</div><table class="source_code">
|
510
|
+
<tr>
|
511
|
+
<td>
|
512
|
+
<pre class="lines">
|
513
|
+
|
514
|
+
|
515
|
+
71
|
516
|
+
72
|
517
|
+
73
|
518
|
+
74
|
519
|
+
75
|
520
|
+
76
|
521
|
+
77
|
522
|
+
78
|
523
|
+
79
|
524
|
+
80
|
525
|
+
81
|
526
|
+
82
|
527
|
+
83
|
528
|
+
84</pre>
|
529
|
+
</td>
|
530
|
+
<td>
|
531
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/structures.rb', line 71</span>
|
532
|
+
|
533
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_stage_volume_ts'>get_stage_volume_ts</span><span class='lparen'>(</span><span class='label'>wdid:</span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_date:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
534
|
+
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='id identifier rubyid_build_query'>build_query</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
535
|
+
<span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span><span class='comma'>,</span>
|
536
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>min-dataMeasDate</span><span class='label_end'>":</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_start_date'>start_date</span><span class='rparen'>)</span><span class='comma'>,</span>
|
537
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>max-dataMeasDate</span><span class='label_end'>":</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_end_date'>end_date</span><span class='rparen'>)</span>
|
538
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
539
|
+
|
540
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
541
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/structures/divrec/stagevolume/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
542
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
543
|
+
<span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
|
544
|
+
<span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_diversion_records'><span class='object_link'><a href="Parser.html#parse_diversion_records-class_method" title="Cdss::Parser.parse_diversion_records (method)">parse_diversion_records</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:stage_volume</span><span class='rparen'>)</span>
|
545
|
+
<span class='kw'>end</span>
|
546
|
+
<span class='kw'>end</span></pre>
|
547
|
+
</td>
|
548
|
+
</tr>
|
549
|
+
</table>
|
550
|
+
</div>
|
551
|
+
|
552
|
+
<div class="method_details ">
|
553
|
+
<h3 class="signature " id="get_structures-instance_method">
|
554
|
+
|
555
|
+
#<strong>get_structures</strong>(aoi: nil, radius: nil, county: nil, division: nil, gnis_id: nil, water_district: nil, wdid: nil) ⇒ <tt>Array<<span class='object_link'><a href="Models/Structure.html" title="Cdss::Models::Structure (class)">Models::Structure</a></span>></tt>
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
</h3><div class="docstring">
|
562
|
+
<div class="discussion">
|
563
|
+
|
564
|
+
<p>Fetches a list of administrative structures based on various filtering criteria.</p>
|
565
|
+
|
566
|
+
|
567
|
+
</div>
|
568
|
+
</div>
|
569
|
+
<div class="tags">
|
570
|
+
<p class="tag_title">Parameters:</p>
|
571
|
+
<ul class="param">
|
572
|
+
|
573
|
+
<li>
|
574
|
+
|
575
|
+
<span class='name'>aoi</span>
|
576
|
+
|
577
|
+
|
578
|
+
<span class='type'>(<tt>Hash</tt>, <tt>Array</tt>, <tt>nil</tt>)</span>
|
579
|
+
|
580
|
+
|
581
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
582
|
+
|
583
|
+
|
584
|
+
—
|
585
|
+
<div class='inline'>
|
586
|
+
<p>Area of interest for spatial searches. If hash, must contain :latitude and :longitude keys.</p>
|
587
|
+
</div>
|
588
|
+
|
589
|
+
</li>
|
590
|
+
|
591
|
+
<li>
|
592
|
+
|
593
|
+
<span class='name'>radius</span>
|
594
|
+
|
595
|
+
|
596
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
597
|
+
|
598
|
+
|
599
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
600
|
+
|
601
|
+
|
602
|
+
—
|
603
|
+
<div class='inline'>
|
604
|
+
<p>Radius in miles for spatial search around aoi. Defaults to 20 if aoi is provided.</p>
|
605
|
+
</div>
|
606
|
+
|
607
|
+
</li>
|
608
|
+
|
609
|
+
<li>
|
610
|
+
|
611
|
+
<span class='name'>county</span>
|
612
|
+
|
613
|
+
|
614
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
615
|
+
|
616
|
+
|
617
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
618
|
+
|
619
|
+
|
620
|
+
—
|
621
|
+
<div class='inline'>
|
622
|
+
<p>County to filter structures.</p>
|
623
|
+
</div>
|
624
|
+
|
625
|
+
</li>
|
626
|
+
|
627
|
+
<li>
|
628
|
+
|
629
|
+
<span class='name'>division</span>
|
630
|
+
|
631
|
+
|
632
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
633
|
+
|
634
|
+
|
635
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
636
|
+
|
637
|
+
|
638
|
+
—
|
639
|
+
<div class='inline'>
|
640
|
+
<p>Water division to filter structures.</p>
|
641
|
+
</div>
|
642
|
+
|
643
|
+
</li>
|
644
|
+
|
645
|
+
<li>
|
646
|
+
|
647
|
+
<span class='name'>gnis_id</span>
|
648
|
+
|
649
|
+
|
650
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
651
|
+
|
652
|
+
|
653
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
654
|
+
|
655
|
+
|
656
|
+
—
|
657
|
+
<div class='inline'>
|
658
|
+
<p>GNIS ID to filter structures.</p>
|
659
|
+
</div>
|
660
|
+
|
661
|
+
</li>
|
662
|
+
|
663
|
+
<li>
|
664
|
+
|
665
|
+
<span class='name'>water_district</span>
|
666
|
+
|
667
|
+
|
668
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
669
|
+
|
670
|
+
|
671
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
672
|
+
|
673
|
+
|
674
|
+
—
|
675
|
+
<div class='inline'>
|
676
|
+
<p>Water district to filter structures.</p>
|
677
|
+
</div>
|
678
|
+
|
679
|
+
</li>
|
680
|
+
|
681
|
+
<li>
|
682
|
+
|
683
|
+
<span class='name'>wdid</span>
|
684
|
+
|
685
|
+
|
686
|
+
<span class='type'>(<tt>String</tt>, <tt>Array<String></tt>, <tt>nil</tt>)</span>
|
687
|
+
|
688
|
+
|
689
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
690
|
+
|
691
|
+
|
692
|
+
—
|
693
|
+
<div class='inline'>
|
694
|
+
<p>WDID code(s) to filter specific structures.</p>
|
695
|
+
</div>
|
696
|
+
|
697
|
+
</li>
|
698
|
+
|
699
|
+
</ul>
|
700
|
+
|
701
|
+
<p class="tag_title">Returns:</p>
|
702
|
+
<ul class="return">
|
703
|
+
|
704
|
+
<li>
|
705
|
+
|
706
|
+
|
707
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/Structure.html" title="Cdss::Models::Structure (class)">Models::Structure</a></span>></tt>)</span>
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
—
|
712
|
+
<div class='inline'>
|
713
|
+
<p>Array of matching structures.</p>
|
714
|
+
</div>
|
715
|
+
|
716
|
+
</li>
|
717
|
+
|
718
|
+
</ul>
|
719
|
+
<p class="tag_title">Raises:</p>
|
720
|
+
<ul class="raise">
|
721
|
+
|
722
|
+
<li>
|
723
|
+
|
724
|
+
|
725
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
726
|
+
|
727
|
+
|
728
|
+
|
729
|
+
—
|
730
|
+
<div class='inline'>
|
731
|
+
<p>If aoi parameter is provided but invalid.</p>
|
732
|
+
</div>
|
733
|
+
|
734
|
+
</li>
|
735
|
+
|
736
|
+
</ul>
|
737
|
+
|
738
|
+
</div><table class="source_code">
|
739
|
+
<tr>
|
740
|
+
<td>
|
741
|
+
<pre class="lines">
|
742
|
+
|
743
|
+
|
744
|
+
22
|
745
|
+
23
|
746
|
+
24
|
747
|
+
25
|
748
|
+
26
|
749
|
+
27
|
750
|
+
28
|
751
|
+
29
|
752
|
+
30
|
753
|
+
31
|
754
|
+
32
|
755
|
+
33
|
756
|
+
34
|
757
|
+
35
|
758
|
+
36
|
759
|
+
37
|
760
|
+
38
|
761
|
+
39
|
762
|
+
40
|
763
|
+
41
|
764
|
+
42
|
765
|
+
43
|
766
|
+
44
|
767
|
+
45
|
768
|
+
46
|
769
|
+
47</pre>
|
770
|
+
</td>
|
771
|
+
<td>
|
772
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/structures.rb', line 22</span>
|
773
|
+
|
774
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_structures'>get_structures</span><span class='lparen'>(</span><span class='label'>aoi:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>radius:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>gnis_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wdid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
775
|
+
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='id identifier rubyid_build_query'>build_query</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
776
|
+
<span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='comma'>,</span>
|
777
|
+
<span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
|
778
|
+
<span class='label'>gnisId:</span> <span class='id identifier rubyid_gnis_id'>gnis_id</span><span class='comma'>,</span>
|
779
|
+
<span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
|
780
|
+
<span class='label'>wdid:</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_wdid'>wdid</span><span class='rparen'>)</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'>%2C+</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
781
|
+
<span class='label'>units:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>miles</span><span class='tstring_end'>"</span></span>
|
782
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
783
|
+
|
784
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_aoi'>aoi</span>
|
785
|
+
<span class='id identifier rubyid_coords'>coords</span> <span class='op'>=</span> <span class='id identifier rubyid_process_aoi'>process_aoi</span><span class='lparen'>(</span><span class='id identifier rubyid_aoi'>aoi</span><span class='rparen'>)</span>
|
786
|
+
<span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
787
|
+
<span class='label'>latitude:</span> <span class='id identifier rubyid_coords'>coords</span><span class='lbracket'>[</span><span class='symbol'>:lat</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
788
|
+
<span class='label'>longitude:</span> <span class='id identifier rubyid_coords'>coords</span><span class='lbracket'>[</span><span class='symbol'>:lng</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
789
|
+
<span class='label'>radius:</span> <span class='id identifier rubyid_radius'>radius</span> <span class='op'>||</span> <span class='int'>20</span>
|
790
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
791
|
+
<span class='kw'>end</span>
|
792
|
+
|
793
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
794
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/structures/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
795
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
796
|
+
<span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
|
797
|
+
<span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_structures'><span class='object_link'><a href="Parser.html#parse_structures-class_method" title="Cdss::Parser.parse_structures (method)">parse_structures</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
798
|
+
<span class='kw'>end</span>
|
799
|
+
<span class='kw'>end</span></pre>
|
800
|
+
</td>
|
801
|
+
</tr>
|
802
|
+
</table>
|
803
|
+
</div>
|
804
|
+
|
805
|
+
<div class="method_details ">
|
806
|
+
<h3 class="signature " id="get_water_classes-instance_method">
|
807
|
+
|
808
|
+
#<strong>get_water_classes</strong>(**params) ⇒ <tt>Array<<span class='object_link'><a href="Models/WaterClass.html" title="Cdss::Models::WaterClass (class)">Models::WaterClass</a></span>></tt>
|
809
|
+
|
810
|
+
|
811
|
+
|
812
|
+
|
813
|
+
|
814
|
+
</h3><div class="docstring">
|
815
|
+
<div class="discussion">
|
816
|
+
|
817
|
+
<p>Fetches water classes for structures.</p>
|
818
|
+
|
819
|
+
|
820
|
+
</div>
|
821
|
+
</div>
|
822
|
+
<div class="tags">
|
823
|
+
<p class="tag_title">Parameters:</p>
|
824
|
+
<ul class="param">
|
825
|
+
|
826
|
+
<li>
|
827
|
+
|
828
|
+
<span class='name'>params</span>
|
829
|
+
|
830
|
+
|
831
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
—
|
836
|
+
<div class='inline'>
|
837
|
+
<p>Query parameters including wdid, county, division, etc.</p>
|
838
|
+
</div>
|
839
|
+
|
840
|
+
</li>
|
841
|
+
|
842
|
+
</ul>
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
<p class="tag_title">Options Hash (<tt>**params</tt>):</p>
|
848
|
+
<ul class="option">
|
849
|
+
|
850
|
+
<li>
|
851
|
+
<span class="name">:wdid</span>
|
852
|
+
<span class="type">(<tt>String</tt>, <tt>Array<String></tt>)</span>
|
853
|
+
<span class="default">
|
854
|
+
|
855
|
+
</span>
|
856
|
+
|
857
|
+
— <div class='inline'>
|
858
|
+
<p>WDID code(s) to filter by</p>
|
859
|
+
</div>
|
860
|
+
|
861
|
+
</li>
|
862
|
+
|
863
|
+
<li>
|
864
|
+
<span class="name">:county</span>
|
865
|
+
<span class="type">(<tt>String</tt>)</span>
|
866
|
+
<span class="default">
|
867
|
+
|
868
|
+
</span>
|
869
|
+
|
870
|
+
— <div class='inline'>
|
871
|
+
<p>County name to filter by</p>
|
872
|
+
</div>
|
873
|
+
|
874
|
+
</li>
|
875
|
+
|
876
|
+
<li>
|
877
|
+
<span class="name">:division</span>
|
878
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
879
|
+
<span class="default">
|
880
|
+
|
881
|
+
</span>
|
882
|
+
|
883
|
+
— <div class='inline'>
|
884
|
+
<p>Division number to filter by</p>
|
885
|
+
</div>
|
886
|
+
|
887
|
+
</li>
|
888
|
+
|
889
|
+
<li>
|
890
|
+
<span class="name">:water_district</span>
|
891
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
892
|
+
<span class="default">
|
893
|
+
|
894
|
+
</span>
|
895
|
+
|
896
|
+
— <div class='inline'>
|
897
|
+
<p>Water district to filter by</p>
|
898
|
+
</div>
|
899
|
+
|
900
|
+
</li>
|
901
|
+
|
902
|
+
<li>
|
903
|
+
<span class="name">:wc_identifier</span>
|
904
|
+
<span class="type">(<tt>String</tt>)</span>
|
905
|
+
<span class="default">
|
906
|
+
|
907
|
+
</span>
|
908
|
+
|
909
|
+
— <div class='inline'>
|
910
|
+
<p>Water class identifier</p>
|
911
|
+
</div>
|
912
|
+
|
913
|
+
</li>
|
914
|
+
|
915
|
+
<li>
|
916
|
+
<span class="name">:timestep</span>
|
917
|
+
<span class="type">(<tt>String</tt>)</span>
|
918
|
+
<span class="default">
|
919
|
+
|
920
|
+
</span>
|
921
|
+
|
922
|
+
— <div class='inline'>
|
923
|
+
<p>Time step for records</p>
|
924
|
+
</div>
|
925
|
+
|
926
|
+
</li>
|
927
|
+
|
928
|
+
<li>
|
929
|
+
<span class="name">:start_date</span>
|
930
|
+
<span class="type">(<tt>Date</tt>)</span>
|
931
|
+
<span class="default">
|
932
|
+
|
933
|
+
</span>
|
934
|
+
|
935
|
+
— <div class='inline'>
|
936
|
+
<p>Start date for records</p>
|
937
|
+
</div>
|
938
|
+
|
939
|
+
</li>
|
940
|
+
|
941
|
+
<li>
|
942
|
+
<span class="name">:end_date</span>
|
943
|
+
<span class="type">(<tt>Date</tt>)</span>
|
944
|
+
<span class="default">
|
945
|
+
|
946
|
+
</span>
|
947
|
+
|
948
|
+
— <div class='inline'>
|
949
|
+
<p>End date for records</p>
|
950
|
+
</div>
|
951
|
+
|
952
|
+
</li>
|
953
|
+
|
954
|
+
<li>
|
955
|
+
<span class="name">:divrectype</span>
|
956
|
+
<span class="type">(<tt>String</tt>)</span>
|
957
|
+
<span class="default">
|
958
|
+
|
959
|
+
</span>
|
960
|
+
|
961
|
+
— <div class='inline'>
|
962
|
+
<p>Diversion record type</p>
|
963
|
+
</div>
|
964
|
+
|
965
|
+
</li>
|
966
|
+
|
967
|
+
<li>
|
968
|
+
<span class="name">:ciu_code</span>
|
969
|
+
<span class="type">(<tt>String</tt>)</span>
|
970
|
+
<span class="default">
|
971
|
+
|
972
|
+
</span>
|
973
|
+
|
974
|
+
— <div class='inline'>
|
975
|
+
<p>CIU code</p>
|
976
|
+
</div>
|
977
|
+
|
978
|
+
</li>
|
979
|
+
|
980
|
+
<li>
|
981
|
+
<span class="name">:gnis_id</span>
|
982
|
+
<span class="type">(<tt>String</tt>)</span>
|
983
|
+
<span class="default">
|
984
|
+
|
985
|
+
</span>
|
986
|
+
|
987
|
+
— <div class='inline'>
|
988
|
+
<p>GNIS ID</p>
|
989
|
+
</div>
|
990
|
+
|
991
|
+
</li>
|
992
|
+
|
993
|
+
<li>
|
994
|
+
<span class="name">:aoi</span>
|
995
|
+
<span class="type">(<tt>Hash</tt>, <tt>Array</tt>)</span>
|
996
|
+
<span class="default">
|
997
|
+
|
998
|
+
</span>
|
999
|
+
|
1000
|
+
— <div class='inline'>
|
1001
|
+
<p>Area of interest for spatial search</p>
|
1002
|
+
</div>
|
1003
|
+
|
1004
|
+
</li>
|
1005
|
+
|
1006
|
+
<li>
|
1007
|
+
<span class="name">:radius</span>
|
1008
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1009
|
+
<span class="default">
|
1010
|
+
|
1011
|
+
</span>
|
1012
|
+
|
1013
|
+
— <div class='inline'>
|
1014
|
+
<p>Radius in miles for spatial search</p>
|
1015
|
+
</div>
|
1016
|
+
|
1017
|
+
</li>
|
1018
|
+
|
1019
|
+
</ul>
|
1020
|
+
|
1021
|
+
|
1022
|
+
<p class="tag_title">Returns:</p>
|
1023
|
+
<ul class="return">
|
1024
|
+
|
1025
|
+
<li>
|
1026
|
+
|
1027
|
+
|
1028
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/WaterClass.html" title="Cdss::Models::WaterClass (class)">Models::WaterClass</a></span>></tt>)</span>
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
1032
|
+
—
|
1033
|
+
<div class='inline'>
|
1034
|
+
<p>Array of water classes.</p>
|
1035
|
+
</div>
|
1036
|
+
|
1037
|
+
</li>
|
1038
|
+
|
1039
|
+
</ul>
|
1040
|
+
|
1041
|
+
</div><table class="source_code">
|
1042
|
+
<tr>
|
1043
|
+
<td>
|
1044
|
+
<pre class="lines">
|
1045
|
+
|
1046
|
+
|
1047
|
+
103
|
1048
|
+
104
|
1049
|
+
105
|
1050
|
+
106
|
1051
|
+
107
|
1052
|
+
108
|
1053
|
+
109
|
1054
|
+
110
|
1055
|
+
111
|
1056
|
+
112
|
1057
|
+
113
|
1058
|
+
114
|
1059
|
+
115
|
1060
|
+
116
|
1061
|
+
117
|
1062
|
+
118
|
1063
|
+
119
|
1064
|
+
120
|
1065
|
+
121
|
1066
|
+
122
|
1067
|
+
123
|
1068
|
+
124
|
1069
|
+
125
|
1070
|
+
126
|
1071
|
+
127
|
1072
|
+
128
|
1073
|
+
129
|
1074
|
+
130
|
1075
|
+
131
|
1076
|
+
132
|
1077
|
+
133
|
1078
|
+
134</pre>
|
1079
|
+
</td>
|
1080
|
+
<td>
|
1081
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/structures.rb', line 103</span>
|
1082
|
+
|
1083
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_water_classes'>get_water_classes</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1084
|
+
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='id identifier rubyid_build_query'>build_query</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
1085
|
+
<span class='label'>wdid:</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:wdid</span><span class='rbracket'>]</span><span class='rparen'>)</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'>%2C+</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
1086
|
+
<span class='label'>county:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:county</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1087
|
+
<span class='label'>division:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:division</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1088
|
+
<span class='label'>waterDistrict:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:water_district</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1089
|
+
<span class='label'>wcIdentifier:</span> <span class='id identifier rubyid_format_wc_identifier'>format_wc_identifier</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:wc_identifier</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
1090
|
+
<span class='label'>timestep:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:timestep</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1091
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>min-porStart</span><span class='label_end'>":</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:start_date</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
1092
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>min-porEnd</span><span class='label_end'>":</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:end_date</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
1093
|
+
<span class='label'>divrectype:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:divrectype</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1094
|
+
<span class='label'>ciuCode:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:ciu_code</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1095
|
+
<span class='label'>gnisId:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:gnis_id</span><span class='rbracket'>]</span>
|
1096
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
1097
|
+
|
1098
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:aoi</span><span class='rbracket'>]</span>
|
1099
|
+
<span class='id identifier rubyid_coords'>coords</span> <span class='op'>=</span> <span class='id identifier rubyid_process_aoi'>process_aoi</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:aoi</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
1100
|
+
<span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
1101
|
+
<span class='label'>latitude:</span> <span class='id identifier rubyid_coords'>coords</span><span class='lbracket'>[</span><span class='symbol'>:lat</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1102
|
+
<span class='label'>longitude:</span> <span class='id identifier rubyid_coords'>coords</span><span class='lbracket'>[</span><span class='symbol'>:lng</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1103
|
+
<span class='label'>radius:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:radius</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>20</span><span class='comma'>,</span>
|
1104
|
+
<span class='label'>units:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>miles</span><span class='tstring_end'>"</span></span>
|
1105
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
1106
|
+
<span class='kw'>end</span>
|
1107
|
+
|
1108
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
1109
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/structures/divrec/waterclasses/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1110
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
1111
|
+
<span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
|
1112
|
+
<span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_water_classes'><span class='object_link'><a href="Parser.html#parse_water_classes-class_method" title="Cdss::Parser.parse_water_classes (method)">parse_water_classes</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1113
|
+
<span class='kw'>end</span>
|
1114
|
+
<span class='kw'>end</span></pre>
|
1115
|
+
</td>
|
1116
|
+
</tr>
|
1117
|
+
</table>
|
1118
|
+
</div>
|
1119
|
+
|
1120
|
+
</div>
|
1121
|
+
|
1122
|
+
</div>
|
1123
|
+
|
1124
|
+
<div id="footer">
|
1125
|
+
Generated on Thu Feb 20 21:19:08 2025 by
|
1126
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1127
|
+
0.9.37 (ruby-3.2.2).
|
1128
|
+
</div>
|
1129
|
+
|
1130
|
+
</div>
|
1131
|
+
</body>
|
1132
|
+
</html>
|