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,2155 @@
|
|
|
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
|
+
Class: Cdss::Parser
|
|
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::Parser";
|
|
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 (P)</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">Parser</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>Class: Cdss::Parser
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Cdss::Parser</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/cdss/parser.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>The Parser class handles parsing of response data from the CDSS API into domain objects. It delegates the actual parsing work to specialized parser modules for each data type.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>
|
|
122
|
+
Class Method Summary
|
|
123
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
124
|
+
</h2>
|
|
125
|
+
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#parse_admin_calls-class_method" title="parse_admin_calls (class method)">.<strong>parse_admin_calls</strong>(response) ⇒ Array<AdminCall> </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'>
|
|
146
|
+
<p>Parses administrative calls data from the API response.</p>
|
|
147
|
+
</div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#parse_call_analyses-class_method" title="parse_call_analyses (class method)">.<strong>parse_call_analyses</strong>(response, type:) ⇒ Array<CallAnalysis> </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
|
170
|
+
<p>Parses call analysis data from the API response.</p>
|
|
171
|
+
</div></span>
|
|
172
|
+
|
|
173
|
+
</li>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<li class="public ">
|
|
177
|
+
<span class="summary_signature">
|
|
178
|
+
|
|
179
|
+
<a href="#parse_climate_readings-class_method" title="parse_climate_readings (class method)">.<strong>parse_climate_readings</strong>(response, type:) ⇒ Array<Reading> </a>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'>
|
|
194
|
+
<p>Parses climate reading data from the API response.</p>
|
|
195
|
+
</div></span>
|
|
196
|
+
|
|
197
|
+
</li>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<li class="public ">
|
|
201
|
+
<span class="summary_signature">
|
|
202
|
+
|
|
203
|
+
<a href="#parse_climate_stations-class_method" title="parse_climate_stations (class method)">.<strong>parse_climate_stations</strong>(response) ⇒ Array<ClimateStation> </a>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="summary_desc"><div class='inline'>
|
|
218
|
+
<p>Parses climate station data from the API response.</p>
|
|
219
|
+
</div></span>
|
|
220
|
+
|
|
221
|
+
</li>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<li class="public ">
|
|
225
|
+
<span class="summary_signature">
|
|
226
|
+
|
|
227
|
+
<a href="#parse_diversion_records-class_method" title="parse_diversion_records (class method)">.<strong>parse_diversion_records</strong>(response, type:) ⇒ Array<Cdss::Models::DiversionRecord> </a>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class="summary_desc"><div class='inline'>
|
|
242
|
+
<p>Parses diversion record data from the API response.</p>
|
|
243
|
+
</div></span>
|
|
244
|
+
|
|
245
|
+
</li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<li class="public ">
|
|
249
|
+
<span class="summary_signature">
|
|
250
|
+
|
|
251
|
+
<a href="#parse_geophysical_wells-class_method" title="parse_geophysical_wells (class method)">.<strong>parse_geophysical_wells</strong>(response) ⇒ Array<Well> </a>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'>
|
|
266
|
+
<p>Parses geophysical well data from the API response.</p>
|
|
267
|
+
</div></span>
|
|
268
|
+
|
|
269
|
+
</li>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<li class="public ">
|
|
273
|
+
<span class="summary_signature">
|
|
274
|
+
|
|
275
|
+
<a href="#parse_log_picks-class_method" title="parse_log_picks (class method)">.<strong>parse_log_picks</strong>(response) ⇒ Array<Reading> </a>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<span class="summary_desc"><div class='inline'>
|
|
290
|
+
<p>Parses geophysical log pick data from the API response.</p>
|
|
291
|
+
</div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#parse_readings-class_method" title="parse_readings (class method)">.<strong>parse_readings</strong>(response, timescale:) ⇒ Array<Reading> </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'>
|
|
314
|
+
<p>Parses time series readings from the API response.</p>
|
|
315
|
+
</div></span>
|
|
316
|
+
|
|
317
|
+
</li>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<li class="public ">
|
|
321
|
+
<span class="summary_signature">
|
|
322
|
+
|
|
323
|
+
<a href="#parse_reference_table-class_method" title="parse_reference_table (class method)">.<strong>parse_reference_table</strong>(response) ⇒ Array<Cdss::Models::ReferenceTable> </a>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="summary_desc"><div class='inline'>
|
|
338
|
+
<p>Parses reference table data from the API response.</p>
|
|
339
|
+
</div></span>
|
|
340
|
+
|
|
341
|
+
</li>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<li class="public ">
|
|
345
|
+
<span class="summary_signature">
|
|
346
|
+
|
|
347
|
+
<a href="#parse_route_analyses-class_method" title="parse_route_analyses (class method)">.<strong>parse_route_analyses</strong>(response) ⇒ Array<RouteAnalysis> </a>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<span class="summary_desc"><div class='inline'>
|
|
362
|
+
<p>Parses route analysis data from the API response.</p>
|
|
363
|
+
</div></span>
|
|
364
|
+
|
|
365
|
+
</li>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<li class="public ">
|
|
369
|
+
<span class="summary_signature">
|
|
370
|
+
|
|
371
|
+
<a href="#parse_source_routes-class_method" title="parse_source_routes (class method)">.<strong>parse_source_routes</strong>(response) ⇒ Array<SourceRoute> </a>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</span>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="summary_desc"><div class='inline'>
|
|
386
|
+
<p>Parses source route framework data from the API response.</p>
|
|
387
|
+
</div></span>
|
|
388
|
+
|
|
389
|
+
</li>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<li class="public ">
|
|
393
|
+
<span class="summary_signature">
|
|
394
|
+
|
|
395
|
+
<a href="#parse_stations-class_method" title="parse_stations (class method)">.<strong>parse_stations</strong>(response) ⇒ Array<Station> </a>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class="summary_desc"><div class='inline'>
|
|
410
|
+
<p>Parses station data from the API response.</p>
|
|
411
|
+
</div></span>
|
|
412
|
+
|
|
413
|
+
</li>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<li class="public ">
|
|
417
|
+
<span class="summary_signature">
|
|
418
|
+
|
|
419
|
+
<a href="#parse_structures-class_method" title="parse_structures (class method)">.<strong>parse_structures</strong>(response) ⇒ Array<Cdss::Models::Structure> </a>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</span>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<span class="summary_desc"><div class='inline'>
|
|
434
|
+
<p>Parses structure data from the API response.</p>
|
|
435
|
+
</div></span>
|
|
436
|
+
|
|
437
|
+
</li>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<li class="public ">
|
|
441
|
+
<span class="summary_signature">
|
|
442
|
+
|
|
443
|
+
<a href="#parse_water_classes-class_method" title="parse_water_classes (class method)">.<strong>parse_water_classes</strong>(response) ⇒ Array<Cdss::Models::WaterClass> </a>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span class="summary_desc"><div class='inline'>
|
|
458
|
+
<p>Parses water class data from the API response.</p>
|
|
459
|
+
</div></span>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<li class="public ">
|
|
465
|
+
<span class="summary_signature">
|
|
466
|
+
|
|
467
|
+
<a href="#parse_water_rights-class_method" title="parse_water_rights (class method)">.<strong>parse_water_rights</strong>(response, type:) ⇒ Array<WaterRight> </a>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<span class="summary_desc"><div class='inline'>
|
|
482
|
+
<p>Parses water rights data from the API response.</p>
|
|
483
|
+
</div></span>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<li class="public ">
|
|
489
|
+
<span class="summary_signature">
|
|
490
|
+
|
|
491
|
+
<a href="#parse_well_measurements-class_method" title="parse_well_measurements (class method)">.<strong>parse_well_measurements</strong>(response) ⇒ Array<Reading> </a>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class="summary_desc"><div class='inline'>
|
|
506
|
+
<p>Parses well measurement data from the API response.</p>
|
|
507
|
+
</div></span>
|
|
508
|
+
|
|
509
|
+
</li>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<li class="public ">
|
|
513
|
+
<span class="summary_signature">
|
|
514
|
+
|
|
515
|
+
<a href="#parse_wells-class_method" title="parse_wells (class method)">.<strong>parse_wells</strong>(response) ⇒ Array<Well> </a>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<span class="summary_desc"><div class='inline'>
|
|
530
|
+
<p>Parses well data from the API response.</p>
|
|
531
|
+
</div></span>
|
|
532
|
+
|
|
533
|
+
</li>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
</ul>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<div id="class_method_details" class="method_details_list">
|
|
542
|
+
<h2>Class Method Details</h2>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<div class="method_details first">
|
|
546
|
+
<h3 class="signature first" id="parse_admin_calls-class_method">
|
|
547
|
+
|
|
548
|
+
.<strong>parse_admin_calls</strong>(response) ⇒ <tt>Array<AdminCall></tt>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
</h3><div class="docstring">
|
|
555
|
+
<div class="discussion">
|
|
556
|
+
|
|
557
|
+
<p>Parses administrative calls data from the API response.</p>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</div>
|
|
561
|
+
</div>
|
|
562
|
+
<div class="tags">
|
|
563
|
+
|
|
564
|
+
<div class="examples">
|
|
565
|
+
<h4 class="tag_title">Examples:</h4>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<h5 class="example_title"><div class='inline'>
|
|
569
|
+
<p>Parse admin calls from response</p>
|
|
570
|
+
</div></h5>
|
|
571
|
+
|
|
572
|
+
<pre class="example code"><code><span class='id identifier rubyid_calls'>calls</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_admin_calls'>parse_admin_calls</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
573
|
+
|
|
574
|
+
</div>
|
|
575
|
+
<p class="tag_title">Parameters:</p>
|
|
576
|
+
<ul class="param">
|
|
577
|
+
|
|
578
|
+
<li>
|
|
579
|
+
|
|
580
|
+
<span class='name'>response</span>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
—
|
|
588
|
+
<div class='inline'>
|
|
589
|
+
<p>The API response containing administrative calls data.</p>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
</li>
|
|
593
|
+
|
|
594
|
+
</ul>
|
|
595
|
+
|
|
596
|
+
<p class="tag_title">Returns:</p>
|
|
597
|
+
<ul class="return">
|
|
598
|
+
|
|
599
|
+
<li>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<span class='type'>(<tt>Array<AdminCall></tt>)</span>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
—
|
|
607
|
+
<div class='inline'>
|
|
608
|
+
<p>Array of administrative call objects.</p>
|
|
609
|
+
</div>
|
|
610
|
+
|
|
611
|
+
</li>
|
|
612
|
+
|
|
613
|
+
</ul>
|
|
614
|
+
|
|
615
|
+
</div><table class="source_code">
|
|
616
|
+
<tr>
|
|
617
|
+
<td>
|
|
618
|
+
<pre class="lines">
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
108
|
|
622
|
+
109
|
|
623
|
+
110</pre>
|
|
624
|
+
</td>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 108</span>
|
|
627
|
+
|
|
628
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_admin_calls'>parse_admin_calls</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
629
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/AdminCallsParser.html" title="Cdss::Parsers::AdminCallsParser (module)">AdminCallsParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_admin_calls'><span class='object_link'><a href="Parsers/AdminCallsParser.html#parse_admin_calls-class_method" title="Cdss::Parsers::AdminCallsParser.parse_admin_calls (method)">parse_admin_calls</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
630
|
+
<span class='kw'>end</span></pre>
|
|
631
|
+
</td>
|
|
632
|
+
</tr>
|
|
633
|
+
</table>
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
<div class="method_details ">
|
|
637
|
+
<h3 class="signature " id="parse_call_analyses-class_method">
|
|
638
|
+
|
|
639
|
+
.<strong>parse_call_analyses</strong>(response, type:) ⇒ <tt>Array<CallAnalysis></tt>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
</h3><div class="docstring">
|
|
646
|
+
<div class="discussion">
|
|
647
|
+
|
|
648
|
+
<p>Parses call analysis data from the API response.</p>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
</div>
|
|
652
|
+
</div>
|
|
653
|
+
<div class="tags">
|
|
654
|
+
<p class="tag_title">Parameters:</p>
|
|
655
|
+
<ul class="param">
|
|
656
|
+
|
|
657
|
+
<li>
|
|
658
|
+
|
|
659
|
+
<span class='name'>response</span>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
—
|
|
667
|
+
<div class='inline'>
|
|
668
|
+
<p>The API response containing call analysis data.</p>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</li>
|
|
672
|
+
|
|
673
|
+
<li>
|
|
674
|
+
|
|
675
|
+
<span class='name'>type</span>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
—
|
|
683
|
+
<div class='inline'>
|
|
684
|
+
<p>The type of analysis (:wdid or :gnis).</p>
|
|
685
|
+
</div>
|
|
686
|
+
|
|
687
|
+
</li>
|
|
688
|
+
|
|
689
|
+
</ul>
|
|
690
|
+
|
|
691
|
+
<p class="tag_title">Returns:</p>
|
|
692
|
+
<ul class="return">
|
|
693
|
+
|
|
694
|
+
<li>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<span class='type'>(<tt>Array<CallAnalysis></tt>)</span>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
—
|
|
702
|
+
<div class='inline'>
|
|
703
|
+
<p>Array of call analysis objects.</p>
|
|
704
|
+
</div>
|
|
705
|
+
|
|
706
|
+
</li>
|
|
707
|
+
|
|
708
|
+
</ul>
|
|
709
|
+
<p class="tag_title">Raises:</p>
|
|
710
|
+
<ul class="raise">
|
|
711
|
+
|
|
712
|
+
<li>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
—
|
|
720
|
+
<div class='inline'>
|
|
721
|
+
<p>If an invalid analysis type is provided.</p>
|
|
722
|
+
</div>
|
|
723
|
+
|
|
724
|
+
</li>
|
|
725
|
+
|
|
726
|
+
</ul>
|
|
727
|
+
|
|
728
|
+
</div><table class="source_code">
|
|
729
|
+
<tr>
|
|
730
|
+
<td>
|
|
731
|
+
<pre class="lines">
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
118
|
|
735
|
+
119
|
|
736
|
+
120</pre>
|
|
737
|
+
</td>
|
|
738
|
+
<td>
|
|
739
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 118</span>
|
|
740
|
+
|
|
741
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_call_analyses'>parse_call_analyses</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span><span class='rparen'>)</span>
|
|
742
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/AnalysisParser.html" title="Cdss::Parsers::AnalysisParser (module)">AnalysisParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_call_analyses'><span class='object_link'><a href="Parsers/AnalysisParser.html#parse_call_analyses-class_method" title="Cdss::Parsers::AnalysisParser.parse_call_analyses (method)">parse_call_analyses</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
743
|
+
<span class='kw'>end</span></pre>
|
|
744
|
+
</td>
|
|
745
|
+
</tr>
|
|
746
|
+
</table>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
<div class="method_details ">
|
|
750
|
+
<h3 class="signature " id="parse_climate_readings-class_method">
|
|
751
|
+
|
|
752
|
+
.<strong>parse_climate_readings</strong>(response, type:) ⇒ <tt>Array<Reading></tt>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
</h3><div class="docstring">
|
|
759
|
+
<div class="discussion">
|
|
760
|
+
|
|
761
|
+
<p>Parses climate reading data from the API response.</p>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
</div>
|
|
765
|
+
</div>
|
|
766
|
+
<div class="tags">
|
|
767
|
+
<p class="tag_title">Parameters:</p>
|
|
768
|
+
<ul class="param">
|
|
769
|
+
|
|
770
|
+
<li>
|
|
771
|
+
|
|
772
|
+
<span class='name'>response</span>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
—
|
|
780
|
+
<div class='inline'>
|
|
781
|
+
<p>The API response containing climate readings.</p>
|
|
782
|
+
</div>
|
|
783
|
+
|
|
784
|
+
</li>
|
|
785
|
+
|
|
786
|
+
<li>
|
|
787
|
+
|
|
788
|
+
<span class='name'>type</span>
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
—
|
|
796
|
+
<div class='inline'>
|
|
797
|
+
<p>The type of climate reading (:frost_dates, :daily, or :monthly).</p>
|
|
798
|
+
</div>
|
|
799
|
+
|
|
800
|
+
</li>
|
|
801
|
+
|
|
802
|
+
</ul>
|
|
803
|
+
|
|
804
|
+
<p class="tag_title">Returns:</p>
|
|
805
|
+
<ul class="return">
|
|
806
|
+
|
|
807
|
+
<li>
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
<span class='type'>(<tt>Array<Reading></tt>)</span>
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
—
|
|
815
|
+
<div class='inline'>
|
|
816
|
+
<p>Array of climate reading objects.</p>
|
|
817
|
+
</div>
|
|
818
|
+
|
|
819
|
+
</li>
|
|
820
|
+
|
|
821
|
+
</ul>
|
|
822
|
+
<p class="tag_title">Raises:</p>
|
|
823
|
+
<ul class="raise">
|
|
824
|
+
|
|
825
|
+
<li>
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
—
|
|
833
|
+
<div class='inline'>
|
|
834
|
+
<p>If an invalid reading type is provided.</p>
|
|
835
|
+
</div>
|
|
836
|
+
|
|
837
|
+
</li>
|
|
838
|
+
|
|
839
|
+
</ul>
|
|
840
|
+
|
|
841
|
+
</div><table class="source_code">
|
|
842
|
+
<tr>
|
|
843
|
+
<td>
|
|
844
|
+
<pre class="lines">
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
98
|
|
848
|
+
99
|
|
849
|
+
100</pre>
|
|
850
|
+
</td>
|
|
851
|
+
<td>
|
|
852
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 98</span>
|
|
853
|
+
|
|
854
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_climate_readings'>parse_climate_readings</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span><span class='rparen'>)</span>
|
|
855
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/ClimateParser.html" title="Cdss::Parsers::ClimateParser (module)">ClimateParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_climate_readings'><span class='object_link'><a href="Parsers/ClimateParser.html#parse_climate_readings-class_method" title="Cdss::Parsers::ClimateParser.parse_climate_readings (method)">parse_climate_readings</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
856
|
+
<span class='kw'>end</span></pre>
|
|
857
|
+
</td>
|
|
858
|
+
</tr>
|
|
859
|
+
</table>
|
|
860
|
+
</div>
|
|
861
|
+
|
|
862
|
+
<div class="method_details ">
|
|
863
|
+
<h3 class="signature " id="parse_climate_stations-class_method">
|
|
864
|
+
|
|
865
|
+
.<strong>parse_climate_stations</strong>(response) ⇒ <tt>Array<ClimateStation></tt>
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
</h3><div class="docstring">
|
|
872
|
+
<div class="discussion">
|
|
873
|
+
|
|
874
|
+
<p>Parses climate station data from the API response.</p>
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
</div>
|
|
878
|
+
</div>
|
|
879
|
+
<div class="tags">
|
|
880
|
+
<p class="tag_title">Parameters:</p>
|
|
881
|
+
<ul class="param">
|
|
882
|
+
|
|
883
|
+
<li>
|
|
884
|
+
|
|
885
|
+
<span class='name'>response</span>
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
—
|
|
893
|
+
<div class='inline'>
|
|
894
|
+
<p>The API response containing climate station data.</p>
|
|
895
|
+
</div>
|
|
896
|
+
|
|
897
|
+
</li>
|
|
898
|
+
|
|
899
|
+
</ul>
|
|
900
|
+
|
|
901
|
+
<p class="tag_title">Returns:</p>
|
|
902
|
+
<ul class="return">
|
|
903
|
+
|
|
904
|
+
<li>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
<span class='type'>(<tt>Array<ClimateStation></tt>)</span>
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
—
|
|
912
|
+
<div class='inline'>
|
|
913
|
+
<p>Array of climate station objects.</p>
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
</li>
|
|
917
|
+
|
|
918
|
+
</ul>
|
|
919
|
+
|
|
920
|
+
</div><table class="source_code">
|
|
921
|
+
<tr>
|
|
922
|
+
<td>
|
|
923
|
+
<pre class="lines">
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
88
|
|
927
|
+
89
|
|
928
|
+
90</pre>
|
|
929
|
+
</td>
|
|
930
|
+
<td>
|
|
931
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 88</span>
|
|
932
|
+
|
|
933
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_climate_stations'>parse_climate_stations</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
934
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/ClimateParser.html" title="Cdss::Parsers::ClimateParser (module)">ClimateParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_climate_stations'><span class='object_link'><a href="Parsers/ClimateParser.html#parse_climate_stations-class_method" title="Cdss::Parsers::ClimateParser.parse_climate_stations (method)">parse_climate_stations</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
935
|
+
<span class='kw'>end</span></pre>
|
|
936
|
+
</td>
|
|
937
|
+
</tr>
|
|
938
|
+
</table>
|
|
939
|
+
</div>
|
|
940
|
+
|
|
941
|
+
<div class="method_details ">
|
|
942
|
+
<h3 class="signature " id="parse_diversion_records-class_method">
|
|
943
|
+
|
|
944
|
+
.<strong>parse_diversion_records</strong>(response, type:) ⇒ <tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Cdss::Models::DiversionRecord</a></span>></tt>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
</h3><div class="docstring">
|
|
951
|
+
<div class="discussion">
|
|
952
|
+
|
|
953
|
+
<p>Parses diversion record data from the API response.</p>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
</div>
|
|
957
|
+
</div>
|
|
958
|
+
<div class="tags">
|
|
959
|
+
<p class="tag_title">Parameters:</p>
|
|
960
|
+
<ul class="param">
|
|
961
|
+
|
|
962
|
+
<li>
|
|
963
|
+
|
|
964
|
+
<span class='name'>response</span>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
—
|
|
972
|
+
<div class='inline'>
|
|
973
|
+
<p>The API response containing diversion record data.</p>
|
|
974
|
+
</div>
|
|
975
|
+
|
|
976
|
+
</li>
|
|
977
|
+
|
|
978
|
+
<li>
|
|
979
|
+
|
|
980
|
+
<span class='name'>type</span>
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
—
|
|
988
|
+
<div class='inline'>
|
|
989
|
+
<p>The type of record (:day, :month, :year, or :stage_volume).</p>
|
|
990
|
+
</div>
|
|
991
|
+
|
|
992
|
+
</li>
|
|
993
|
+
|
|
994
|
+
</ul>
|
|
995
|
+
|
|
996
|
+
<p class="tag_title">Returns:</p>
|
|
997
|
+
<ul class="return">
|
|
998
|
+
|
|
999
|
+
<li>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/DiversionRecord.html" title="Cdss::Models::DiversionRecord (class)">Cdss::Models::DiversionRecord</a></span>></tt>)</span>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
—
|
|
1007
|
+
<div class='inline'>
|
|
1008
|
+
<p>Array of diversion record objects.</p>
|
|
1009
|
+
</div>
|
|
1010
|
+
|
|
1011
|
+
</li>
|
|
1012
|
+
|
|
1013
|
+
</ul>
|
|
1014
|
+
|
|
1015
|
+
</div><table class="source_code">
|
|
1016
|
+
<tr>
|
|
1017
|
+
<td>
|
|
1018
|
+
<pre class="lines">
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
151
|
|
1022
|
+
152
|
|
1023
|
+
153</pre>
|
|
1024
|
+
</td>
|
|
1025
|
+
<td>
|
|
1026
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 151</span>
|
|
1027
|
+
|
|
1028
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_diversion_records'>parse_diversion_records</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span><span class='rparen'>)</span>
|
|
1029
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/StructuresParser.html" title="Cdss::Parsers::StructuresParser (module)">StructuresParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_diversion_records'><span class='object_link'><a href="Parsers/StructuresParser.html#parse_diversion_records-class_method" title="Cdss::Parsers::StructuresParser.parse_diversion_records (method)">parse_diversion_records</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
1030
|
+
<span class='kw'>end</span></pre>
|
|
1031
|
+
</td>
|
|
1032
|
+
</tr>
|
|
1033
|
+
</table>
|
|
1034
|
+
</div>
|
|
1035
|
+
|
|
1036
|
+
<div class="method_details ">
|
|
1037
|
+
<h3 class="signature " id="parse_geophysical_wells-class_method">
|
|
1038
|
+
|
|
1039
|
+
.<strong>parse_geophysical_wells</strong>(response) ⇒ <tt>Array<Well></tt>
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
</h3><div class="docstring">
|
|
1046
|
+
<div class="discussion">
|
|
1047
|
+
|
|
1048
|
+
<p>Parses geophysical well data from the API response.</p>
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
</div>
|
|
1052
|
+
</div>
|
|
1053
|
+
<div class="tags">
|
|
1054
|
+
|
|
1055
|
+
<div class="examples">
|
|
1056
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
<h5 class="example_title"><div class='inline'>
|
|
1060
|
+
<p>Parse geophysical wells</p>
|
|
1061
|
+
</div></h5>
|
|
1062
|
+
|
|
1063
|
+
<pre class="example code"><code><span class='id identifier rubyid_geo_wells'>geo_wells</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_geophysical_wells'>parse_geophysical_wells</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
1064
|
+
|
|
1065
|
+
</div>
|
|
1066
|
+
<p class="tag_title">Parameters:</p>
|
|
1067
|
+
<ul class="param">
|
|
1068
|
+
|
|
1069
|
+
<li>
|
|
1070
|
+
|
|
1071
|
+
<span class='name'>response</span>
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
—
|
|
1079
|
+
<div class='inline'>
|
|
1080
|
+
<p>The API response containing geophysical well data.</p>
|
|
1081
|
+
</div>
|
|
1082
|
+
|
|
1083
|
+
</li>
|
|
1084
|
+
|
|
1085
|
+
</ul>
|
|
1086
|
+
|
|
1087
|
+
<p class="tag_title">Returns:</p>
|
|
1088
|
+
<ul class="return">
|
|
1089
|
+
|
|
1090
|
+
<li>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<span class='type'>(<tt>Array<Well></tt>)</span>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
—
|
|
1098
|
+
<div class='inline'>
|
|
1099
|
+
<p>Array of Well objects with geophysical well information.</p>
|
|
1100
|
+
</div>
|
|
1101
|
+
|
|
1102
|
+
</li>
|
|
1103
|
+
|
|
1104
|
+
</ul>
|
|
1105
|
+
|
|
1106
|
+
</div><table class="source_code">
|
|
1107
|
+
<tr>
|
|
1108
|
+
<td>
|
|
1109
|
+
<pre class="lines">
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
56
|
|
1113
|
+
57
|
|
1114
|
+
58</pre>
|
|
1115
|
+
</td>
|
|
1116
|
+
<td>
|
|
1117
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 56</span>
|
|
1118
|
+
|
|
1119
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_geophysical_wells'>parse_geophysical_wells</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1120
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/WellParser.html" title="Cdss::Parsers::WellParser (module)">WellParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_geophysical_wells'><span class='object_link'><a href="Parsers/WellParser.html#parse_geophysical_wells-class_method" title="Cdss::Parsers::WellParser.parse_geophysical_wells (method)">parse_geophysical_wells</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1121
|
+
<span class='kw'>end</span></pre>
|
|
1122
|
+
</td>
|
|
1123
|
+
</tr>
|
|
1124
|
+
</table>
|
|
1125
|
+
</div>
|
|
1126
|
+
|
|
1127
|
+
<div class="method_details ">
|
|
1128
|
+
<h3 class="signature " id="parse_log_picks-class_method">
|
|
1129
|
+
|
|
1130
|
+
.<strong>parse_log_picks</strong>(response) ⇒ <tt>Array<Reading></tt>
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
</h3><div class="docstring">
|
|
1137
|
+
<div class="discussion">
|
|
1138
|
+
|
|
1139
|
+
<p>Parses geophysical log pick data from the API response.</p>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</div>
|
|
1143
|
+
</div>
|
|
1144
|
+
<div class="tags">
|
|
1145
|
+
|
|
1146
|
+
<div class="examples">
|
|
1147
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
<h5 class="example_title"><div class='inline'>
|
|
1151
|
+
<p>Parse log picks for a well</p>
|
|
1152
|
+
</div></h5>
|
|
1153
|
+
|
|
1154
|
+
<pre class="example code"><code><span class='id identifier rubyid_picks'>picks</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_log_picks'>parse_log_picks</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
1155
|
+
|
|
1156
|
+
</div>
|
|
1157
|
+
<p class="tag_title">Parameters:</p>
|
|
1158
|
+
<ul class="param">
|
|
1159
|
+
|
|
1160
|
+
<li>
|
|
1161
|
+
|
|
1162
|
+
<span class='name'>response</span>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
—
|
|
1170
|
+
<div class='inline'>
|
|
1171
|
+
<p>The API response containing log pick data.</p>
|
|
1172
|
+
</div>
|
|
1173
|
+
|
|
1174
|
+
</li>
|
|
1175
|
+
|
|
1176
|
+
</ul>
|
|
1177
|
+
|
|
1178
|
+
<p class="tag_title">Returns:</p>
|
|
1179
|
+
<ul class="return">
|
|
1180
|
+
|
|
1181
|
+
<li>
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
<span class='type'>(<tt>Array<Reading></tt>)</span>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
—
|
|
1189
|
+
<div class='inline'>
|
|
1190
|
+
<p>Array of Reading objects containing log pick information.</p>
|
|
1191
|
+
</div>
|
|
1192
|
+
|
|
1193
|
+
</li>
|
|
1194
|
+
|
|
1195
|
+
</ul>
|
|
1196
|
+
|
|
1197
|
+
</div><table class="source_code">
|
|
1198
|
+
<tr>
|
|
1199
|
+
<td>
|
|
1200
|
+
<pre class="lines">
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
66
|
|
1204
|
+
67
|
|
1205
|
+
68</pre>
|
|
1206
|
+
</td>
|
|
1207
|
+
<td>
|
|
1208
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 66</span>
|
|
1209
|
+
|
|
1210
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_log_picks'>parse_log_picks</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1211
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/WellParser.html" title="Cdss::Parsers::WellParser (module)">WellParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_log_picks'><span class='object_link'><a href="Parsers/WellParser.html#parse_log_picks-class_method" title="Cdss::Parsers::WellParser.parse_log_picks (method)">parse_log_picks</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1212
|
+
<span class='kw'>end</span></pre>
|
|
1213
|
+
</td>
|
|
1214
|
+
</tr>
|
|
1215
|
+
</table>
|
|
1216
|
+
</div>
|
|
1217
|
+
|
|
1218
|
+
<div class="method_details ">
|
|
1219
|
+
<h3 class="signature " id="parse_readings-class_method">
|
|
1220
|
+
|
|
1221
|
+
.<strong>parse_readings</strong>(response, timescale:) ⇒ <tt>Array<Reading></tt>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
</h3><div class="docstring">
|
|
1228
|
+
<div class="discussion">
|
|
1229
|
+
|
|
1230
|
+
<p>Parses time series readings from the API response.</p>
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
</div>
|
|
1234
|
+
</div>
|
|
1235
|
+
<div class="tags">
|
|
1236
|
+
|
|
1237
|
+
<div class="examples">
|
|
1238
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
<h5 class="example_title"><div class='inline'>
|
|
1242
|
+
<p>Parse daily readings</p>
|
|
1243
|
+
</div></h5>
|
|
1244
|
+
|
|
1245
|
+
<pre class="example code"><code><span class='id identifier rubyid_readings'>readings</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_readings'>parse_readings</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='comma'>,</span> <span class='label'>timescale:</span> <span class='symbol'>:day</span><span class='rparen'>)</span></code></pre>
|
|
1246
|
+
|
|
1247
|
+
</div>
|
|
1248
|
+
<p class="tag_title">Parameters:</p>
|
|
1249
|
+
<ul class="param">
|
|
1250
|
+
|
|
1251
|
+
<li>
|
|
1252
|
+
|
|
1253
|
+
<span class='name'>response</span>
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
—
|
|
1261
|
+
<div class='inline'>
|
|
1262
|
+
<p>The API response containing reading data.</p>
|
|
1263
|
+
</div>
|
|
1264
|
+
|
|
1265
|
+
</li>
|
|
1266
|
+
|
|
1267
|
+
<li>
|
|
1268
|
+
|
|
1269
|
+
<span class='name'>timescale</span>
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
—
|
|
1277
|
+
<div class='inline'>
|
|
1278
|
+
<p>The timescale of the readings (:day, :month, :year, :raw, :hour).</p>
|
|
1279
|
+
</div>
|
|
1280
|
+
|
|
1281
|
+
</li>
|
|
1282
|
+
|
|
1283
|
+
</ul>
|
|
1284
|
+
|
|
1285
|
+
<p class="tag_title">Returns:</p>
|
|
1286
|
+
<ul class="return">
|
|
1287
|
+
|
|
1288
|
+
<li>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<span class='type'>(<tt>Array<Reading></tt>)</span>
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
—
|
|
1296
|
+
<div class='inline'>
|
|
1297
|
+
<p>Array of Reading objects with time series data.</p>
|
|
1298
|
+
</div>
|
|
1299
|
+
|
|
1300
|
+
</li>
|
|
1301
|
+
|
|
1302
|
+
</ul>
|
|
1303
|
+
<p class="tag_title">Raises:</p>
|
|
1304
|
+
<ul class="raise">
|
|
1305
|
+
|
|
1306
|
+
<li>
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
—
|
|
1314
|
+
<div class='inline'>
|
|
1315
|
+
<p>If an invalid timescale is provided.</p>
|
|
1316
|
+
</div>
|
|
1317
|
+
|
|
1318
|
+
</li>
|
|
1319
|
+
|
|
1320
|
+
</ul>
|
|
1321
|
+
|
|
1322
|
+
</div><table class="source_code">
|
|
1323
|
+
<tr>
|
|
1324
|
+
<td>
|
|
1325
|
+
<pre class="lines">
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
26
|
|
1329
|
+
27
|
|
1330
|
+
28</pre>
|
|
1331
|
+
</td>
|
|
1332
|
+
<td>
|
|
1333
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 26</span>
|
|
1334
|
+
|
|
1335
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_readings'>parse_readings</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>timescale:</span><span class='rparen'>)</span>
|
|
1336
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/ReadingParser.html" title="Cdss::Parsers::ReadingParser (module)">ReadingParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_readings'><span class='object_link'><a href="Parsers/ReadingParser.html#parse_readings-class_method" title="Cdss::Parsers::ReadingParser.parse_readings (method)">parse_readings</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>timescale:</span> <span class='id identifier rubyid_timescale'>timescale</span><span class='rparen'>)</span>
|
|
1337
|
+
<span class='kw'>end</span></pre>
|
|
1338
|
+
</td>
|
|
1339
|
+
</tr>
|
|
1340
|
+
</table>
|
|
1341
|
+
</div>
|
|
1342
|
+
|
|
1343
|
+
<div class="method_details ">
|
|
1344
|
+
<h3 class="signature " id="parse_reference_table-class_method">
|
|
1345
|
+
|
|
1346
|
+
.<strong>parse_reference_table</strong>(response) ⇒ <tt>Array<<span class='object_link'><a href="Models/ReferenceTable.html" title="Cdss::Models::ReferenceTable (class)">Cdss::Models::ReferenceTable</a></span>></tt>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
</h3><div class="docstring">
|
|
1353
|
+
<div class="discussion">
|
|
1354
|
+
|
|
1355
|
+
<p>Parses reference table data from the API response.</p>
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
</div>
|
|
1359
|
+
</div>
|
|
1360
|
+
<div class="tags">
|
|
1361
|
+
<p class="tag_title">Parameters:</p>
|
|
1362
|
+
<ul class="param">
|
|
1363
|
+
|
|
1364
|
+
<li>
|
|
1365
|
+
|
|
1366
|
+
<span class='name'>response</span>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
—
|
|
1374
|
+
<div class='inline'>
|
|
1375
|
+
<p>The API response containing reference table data.</p>
|
|
1376
|
+
</div>
|
|
1377
|
+
|
|
1378
|
+
</li>
|
|
1379
|
+
|
|
1380
|
+
</ul>
|
|
1381
|
+
|
|
1382
|
+
<p class="tag_title">Returns:</p>
|
|
1383
|
+
<ul class="return">
|
|
1384
|
+
|
|
1385
|
+
<li>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/ReferenceTable.html" title="Cdss::Models::ReferenceTable (class)">Cdss::Models::ReferenceTable</a></span>></tt>)</span>
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
—
|
|
1393
|
+
<div class='inline'>
|
|
1394
|
+
<p>Array of reference table objects.</p>
|
|
1395
|
+
</div>
|
|
1396
|
+
|
|
1397
|
+
</li>
|
|
1398
|
+
|
|
1399
|
+
</ul>
|
|
1400
|
+
|
|
1401
|
+
</div><table class="source_code">
|
|
1402
|
+
<tr>
|
|
1403
|
+
<td>
|
|
1404
|
+
<pre class="lines">
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
167
|
|
1408
|
+
168
|
|
1409
|
+
169</pre>
|
|
1410
|
+
</td>
|
|
1411
|
+
<td>
|
|
1412
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 167</span>
|
|
1413
|
+
|
|
1414
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_reference_table'>parse_reference_table</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1415
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/ReferenceTablesParser.html" title="Cdss::Parsers::ReferenceTablesParser (module)">ReferenceTablesParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_reference_table'><span class='object_link'><a href="Parsers/ReferenceTablesParser.html#parse_reference_table-class_method" title="Cdss::Parsers::ReferenceTablesParser.parse_reference_table (method)">parse_reference_table</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1416
|
+
<span class='kw'>end</span></pre>
|
|
1417
|
+
</td>
|
|
1418
|
+
</tr>
|
|
1419
|
+
</table>
|
|
1420
|
+
</div>
|
|
1421
|
+
|
|
1422
|
+
<div class="method_details ">
|
|
1423
|
+
<h3 class="signature " id="parse_route_analyses-class_method">
|
|
1424
|
+
|
|
1425
|
+
.<strong>parse_route_analyses</strong>(response) ⇒ <tt>Array<RouteAnalysis></tt>
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
</h3><div class="docstring">
|
|
1432
|
+
<div class="discussion">
|
|
1433
|
+
|
|
1434
|
+
<p>Parses route analysis data from the API response.</p>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
</div>
|
|
1438
|
+
</div>
|
|
1439
|
+
<div class="tags">
|
|
1440
|
+
<p class="tag_title">Parameters:</p>
|
|
1441
|
+
<ul class="param">
|
|
1442
|
+
|
|
1443
|
+
<li>
|
|
1444
|
+
|
|
1445
|
+
<span class='name'>response</span>
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
—
|
|
1453
|
+
<div class='inline'>
|
|
1454
|
+
<p>The API response containing route analysis data.</p>
|
|
1455
|
+
</div>
|
|
1456
|
+
|
|
1457
|
+
</li>
|
|
1458
|
+
|
|
1459
|
+
</ul>
|
|
1460
|
+
|
|
1461
|
+
<p class="tag_title">Returns:</p>
|
|
1462
|
+
<ul class="return">
|
|
1463
|
+
|
|
1464
|
+
<li>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
<span class='type'>(<tt>Array<RouteAnalysis></tt>)</span>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
—
|
|
1472
|
+
<div class='inline'>
|
|
1473
|
+
<p>Array of route analysis objects.</p>
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
</li>
|
|
1477
|
+
|
|
1478
|
+
</ul>
|
|
1479
|
+
|
|
1480
|
+
</div><table class="source_code">
|
|
1481
|
+
<tr>
|
|
1482
|
+
<td>
|
|
1483
|
+
<pre class="lines">
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
134
|
|
1487
|
+
135
|
|
1488
|
+
136</pre>
|
|
1489
|
+
</td>
|
|
1490
|
+
<td>
|
|
1491
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 134</span>
|
|
1492
|
+
|
|
1493
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_route_analyses'>parse_route_analyses</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1494
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/AnalysisParser.html" title="Cdss::Parsers::AnalysisParser (module)">AnalysisParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_route_analyses'><span class='object_link'><a href="Parsers/AnalysisParser.html#parse_route_analyses-class_method" title="Cdss::Parsers::AnalysisParser.parse_route_analyses (method)">parse_route_analyses</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1495
|
+
<span class='kw'>end</span></pre>
|
|
1496
|
+
</td>
|
|
1497
|
+
</tr>
|
|
1498
|
+
</table>
|
|
1499
|
+
</div>
|
|
1500
|
+
|
|
1501
|
+
<div class="method_details ">
|
|
1502
|
+
<h3 class="signature " id="parse_source_routes-class_method">
|
|
1503
|
+
|
|
1504
|
+
.<strong>parse_source_routes</strong>(response) ⇒ <tt>Array<SourceRoute></tt>
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
</h3><div class="docstring">
|
|
1511
|
+
<div class="discussion">
|
|
1512
|
+
|
|
1513
|
+
<p>Parses source route framework data from the API response.</p>
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
</div>
|
|
1517
|
+
</div>
|
|
1518
|
+
<div class="tags">
|
|
1519
|
+
<p class="tag_title">Parameters:</p>
|
|
1520
|
+
<ul class="param">
|
|
1521
|
+
|
|
1522
|
+
<li>
|
|
1523
|
+
|
|
1524
|
+
<span class='name'>response</span>
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
—
|
|
1532
|
+
<div class='inline'>
|
|
1533
|
+
<p>The API response containing source route data.</p>
|
|
1534
|
+
</div>
|
|
1535
|
+
|
|
1536
|
+
</li>
|
|
1537
|
+
|
|
1538
|
+
</ul>
|
|
1539
|
+
|
|
1540
|
+
<p class="tag_title">Returns:</p>
|
|
1541
|
+
<ul class="return">
|
|
1542
|
+
|
|
1543
|
+
<li>
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
<span class='type'>(<tt>Array<SourceRoute></tt>)</span>
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
—
|
|
1551
|
+
<div class='inline'>
|
|
1552
|
+
<p>Array of source route objects.</p>
|
|
1553
|
+
</div>
|
|
1554
|
+
|
|
1555
|
+
</li>
|
|
1556
|
+
|
|
1557
|
+
</ul>
|
|
1558
|
+
|
|
1559
|
+
</div><table class="source_code">
|
|
1560
|
+
<tr>
|
|
1561
|
+
<td>
|
|
1562
|
+
<pre class="lines">
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
126
|
|
1566
|
+
127
|
|
1567
|
+
128</pre>
|
|
1568
|
+
</td>
|
|
1569
|
+
<td>
|
|
1570
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 126</span>
|
|
1571
|
+
|
|
1572
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_source_routes'>parse_source_routes</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1573
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/AnalysisParser.html" title="Cdss::Parsers::AnalysisParser (module)">AnalysisParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_source_routes'><span class='object_link'><a href="Parsers/AnalysisParser.html#parse_source_routes-class_method" title="Cdss::Parsers::AnalysisParser.parse_source_routes (method)">parse_source_routes</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1574
|
+
<span class='kw'>end</span></pre>
|
|
1575
|
+
</td>
|
|
1576
|
+
</tr>
|
|
1577
|
+
</table>
|
|
1578
|
+
</div>
|
|
1579
|
+
|
|
1580
|
+
<div class="method_details ">
|
|
1581
|
+
<h3 class="signature " id="parse_stations-class_method">
|
|
1582
|
+
|
|
1583
|
+
.<strong>parse_stations</strong>(response) ⇒ <tt>Array<Station></tt>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
</h3><div class="docstring">
|
|
1590
|
+
<div class="discussion">
|
|
1591
|
+
|
|
1592
|
+
<p>Parses station data from the API response.</p>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
</div>
|
|
1596
|
+
</div>
|
|
1597
|
+
<div class="tags">
|
|
1598
|
+
|
|
1599
|
+
<div class="examples">
|
|
1600
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
<h5 class="example_title"><div class='inline'>
|
|
1604
|
+
<p>Parse stations from API response</p>
|
|
1605
|
+
</div></h5>
|
|
1606
|
+
|
|
1607
|
+
<pre class="example code"><code><span class='id identifier rubyid_stations'>stations</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_stations'>parse_stations</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
1608
|
+
|
|
1609
|
+
</div>
|
|
1610
|
+
<p class="tag_title">Parameters:</p>
|
|
1611
|
+
<ul class="param">
|
|
1612
|
+
|
|
1613
|
+
<li>
|
|
1614
|
+
|
|
1615
|
+
<span class='name'>response</span>
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
—
|
|
1623
|
+
<div class='inline'>
|
|
1624
|
+
<p>The API response containing station data.</p>
|
|
1625
|
+
</div>
|
|
1626
|
+
|
|
1627
|
+
</li>
|
|
1628
|
+
|
|
1629
|
+
</ul>
|
|
1630
|
+
|
|
1631
|
+
<p class="tag_title">Returns:</p>
|
|
1632
|
+
<ul class="return">
|
|
1633
|
+
|
|
1634
|
+
<li>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
<span class='type'>(<tt>Array<Station></tt>)</span>
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
—
|
|
1642
|
+
<div class='inline'>
|
|
1643
|
+
<p>Array of Station objects representing telemetry or surface water stations.</p>
|
|
1644
|
+
</div>
|
|
1645
|
+
|
|
1646
|
+
</li>
|
|
1647
|
+
|
|
1648
|
+
</ul>
|
|
1649
|
+
|
|
1650
|
+
</div><table class="source_code">
|
|
1651
|
+
<tr>
|
|
1652
|
+
<td>
|
|
1653
|
+
<pre class="lines">
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
14
|
|
1657
|
+
15
|
|
1658
|
+
16</pre>
|
|
1659
|
+
</td>
|
|
1660
|
+
<td>
|
|
1661
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 14</span>
|
|
1662
|
+
|
|
1663
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_stations'>parse_stations</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1664
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/StationParser.html" title="Cdss::Parsers::StationParser (module)">StationParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_stations'><span class='object_link'><a href="Parsers/StationParser.html#parse_stations-class_method" title="Cdss::Parsers::StationParser.parse_stations (method)">parse_stations</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1665
|
+
<span class='kw'>end</span></pre>
|
|
1666
|
+
</td>
|
|
1667
|
+
</tr>
|
|
1668
|
+
</table>
|
|
1669
|
+
</div>
|
|
1670
|
+
|
|
1671
|
+
<div class="method_details ">
|
|
1672
|
+
<h3 class="signature " id="parse_structures-class_method">
|
|
1673
|
+
|
|
1674
|
+
.<strong>parse_structures</strong>(response) ⇒ <tt>Array<<span class='object_link'><a href="Models/Structure.html" title="Cdss::Models::Structure (class)">Cdss::Models::Structure</a></span>></tt>
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
</h3><div class="docstring">
|
|
1681
|
+
<div class="discussion">
|
|
1682
|
+
|
|
1683
|
+
<p>Parses structure data from the API response.</p>
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
</div>
|
|
1687
|
+
</div>
|
|
1688
|
+
<div class="tags">
|
|
1689
|
+
<p class="tag_title">Parameters:</p>
|
|
1690
|
+
<ul class="param">
|
|
1691
|
+
|
|
1692
|
+
<li>
|
|
1693
|
+
|
|
1694
|
+
<span class='name'>response</span>
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
—
|
|
1702
|
+
<div class='inline'>
|
|
1703
|
+
<p>The API response containing structure data.</p>
|
|
1704
|
+
</div>
|
|
1705
|
+
|
|
1706
|
+
</li>
|
|
1707
|
+
|
|
1708
|
+
</ul>
|
|
1709
|
+
|
|
1710
|
+
<p class="tag_title">Returns:</p>
|
|
1711
|
+
<ul class="return">
|
|
1712
|
+
|
|
1713
|
+
<li>
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/Structure.html" title="Cdss::Models::Structure (class)">Cdss::Models::Structure</a></span>></tt>)</span>
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
—
|
|
1721
|
+
<div class='inline'>
|
|
1722
|
+
<p>Array of structure objects.</p>
|
|
1723
|
+
</div>
|
|
1724
|
+
|
|
1725
|
+
</li>
|
|
1726
|
+
|
|
1727
|
+
</ul>
|
|
1728
|
+
|
|
1729
|
+
</div><table class="source_code">
|
|
1730
|
+
<tr>
|
|
1731
|
+
<td>
|
|
1732
|
+
<pre class="lines">
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
142
|
|
1736
|
+
143
|
|
1737
|
+
144</pre>
|
|
1738
|
+
</td>
|
|
1739
|
+
<td>
|
|
1740
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 142</span>
|
|
1741
|
+
|
|
1742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_structures'>parse_structures</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1743
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/StructuresParser.html" title="Cdss::Parsers::StructuresParser (module)">StructuresParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_structures'><span class='object_link'><a href="Parsers/StructuresParser.html#parse_structures-class_method" title="Cdss::Parsers::StructuresParser.parse_structures (method)">parse_structures</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1744
|
+
<span class='kw'>end</span></pre>
|
|
1745
|
+
</td>
|
|
1746
|
+
</tr>
|
|
1747
|
+
</table>
|
|
1748
|
+
</div>
|
|
1749
|
+
|
|
1750
|
+
<div class="method_details ">
|
|
1751
|
+
<h3 class="signature " id="parse_water_classes-class_method">
|
|
1752
|
+
|
|
1753
|
+
.<strong>parse_water_classes</strong>(response) ⇒ <tt>Array<<span class='object_link'><a href="Models/WaterClass.html" title="Cdss::Models::WaterClass (class)">Cdss::Models::WaterClass</a></span>></tt>
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
</h3><div class="docstring">
|
|
1760
|
+
<div class="discussion">
|
|
1761
|
+
|
|
1762
|
+
<p>Parses water class data from the API response.</p>
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
</div>
|
|
1766
|
+
</div>
|
|
1767
|
+
<div class="tags">
|
|
1768
|
+
<p class="tag_title">Parameters:</p>
|
|
1769
|
+
<ul class="param">
|
|
1770
|
+
|
|
1771
|
+
<li>
|
|
1772
|
+
|
|
1773
|
+
<span class='name'>response</span>
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
—
|
|
1781
|
+
<div class='inline'>
|
|
1782
|
+
<p>The API response containing water class data.</p>
|
|
1783
|
+
</div>
|
|
1784
|
+
|
|
1785
|
+
</li>
|
|
1786
|
+
|
|
1787
|
+
</ul>
|
|
1788
|
+
|
|
1789
|
+
<p class="tag_title">Returns:</p>
|
|
1790
|
+
<ul class="return">
|
|
1791
|
+
|
|
1792
|
+
<li>
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Models/WaterClass.html" title="Cdss::Models::WaterClass (class)">Cdss::Models::WaterClass</a></span>></tt>)</span>
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
—
|
|
1800
|
+
<div class='inline'>
|
|
1801
|
+
<p>Array of water class objects.</p>
|
|
1802
|
+
</div>
|
|
1803
|
+
|
|
1804
|
+
</li>
|
|
1805
|
+
|
|
1806
|
+
</ul>
|
|
1807
|
+
|
|
1808
|
+
</div><table class="source_code">
|
|
1809
|
+
<tr>
|
|
1810
|
+
<td>
|
|
1811
|
+
<pre class="lines">
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
159
|
|
1815
|
+
160
|
|
1816
|
+
161</pre>
|
|
1817
|
+
</td>
|
|
1818
|
+
<td>
|
|
1819
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 159</span>
|
|
1820
|
+
|
|
1821
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_water_classes'>parse_water_classes</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1822
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/StructuresParser.html" title="Cdss::Parsers::StructuresParser (module)">StructuresParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_water_classes'><span class='object_link'><a href="Parsers/StructuresParser.html#parse_water_classes-class_method" title="Cdss::Parsers::StructuresParser.parse_water_classes (method)">parse_water_classes</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
1823
|
+
<span class='kw'>end</span></pre>
|
|
1824
|
+
</td>
|
|
1825
|
+
</tr>
|
|
1826
|
+
</table>
|
|
1827
|
+
</div>
|
|
1828
|
+
|
|
1829
|
+
<div class="method_details ">
|
|
1830
|
+
<h3 class="signature " id="parse_water_rights-class_method">
|
|
1831
|
+
|
|
1832
|
+
.<strong>parse_water_rights</strong>(response, type:) ⇒ <tt>Array<WaterRight></tt>
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
</h3><div class="docstring">
|
|
1839
|
+
<div class="discussion">
|
|
1840
|
+
|
|
1841
|
+
<p>Parses water rights data from the API response.</p>
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
</div>
|
|
1845
|
+
</div>
|
|
1846
|
+
<div class="tags">
|
|
1847
|
+
|
|
1848
|
+
<div class="examples">
|
|
1849
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
<h5 class="example_title"><div class='inline'>
|
|
1853
|
+
<p>Parse net amounts</p>
|
|
1854
|
+
</div></h5>
|
|
1855
|
+
|
|
1856
|
+
<pre class="example code"><code><span class='id identifier rubyid_rights'>rights</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_water_rights'>parse_water_rights</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:net_amount</span><span class='rparen'>)</span></code></pre>
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
<h5 class="example_title"><div class='inline'>
|
|
1860
|
+
<p>Parse transactions</p>
|
|
1861
|
+
</div></h5>
|
|
1862
|
+
|
|
1863
|
+
<pre class="example code"><code><span class='id identifier rubyid_transactions'>transactions</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_water_rights'>parse_water_rights</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:transaction</span><span class='rparen'>)</span></code></pre>
|
|
1864
|
+
|
|
1865
|
+
</div>
|
|
1866
|
+
<p class="tag_title">Parameters:</p>
|
|
1867
|
+
<ul class="param">
|
|
1868
|
+
|
|
1869
|
+
<li>
|
|
1870
|
+
|
|
1871
|
+
<span class='name'>response</span>
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
—
|
|
1879
|
+
<div class='inline'>
|
|
1880
|
+
<p>The API response containing water rights data.</p>
|
|
1881
|
+
</div>
|
|
1882
|
+
|
|
1883
|
+
</li>
|
|
1884
|
+
|
|
1885
|
+
<li>
|
|
1886
|
+
|
|
1887
|
+
<span class='name'>type</span>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
—
|
|
1895
|
+
<div class='inline'>
|
|
1896
|
+
<p>The type of water rights data to parse (:net_amount or :transaction).</p>
|
|
1897
|
+
</div>
|
|
1898
|
+
|
|
1899
|
+
</li>
|
|
1900
|
+
|
|
1901
|
+
</ul>
|
|
1902
|
+
|
|
1903
|
+
<p class="tag_title">Returns:</p>
|
|
1904
|
+
<ul class="return">
|
|
1905
|
+
|
|
1906
|
+
<li>
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
<span class='type'>(<tt>Array<WaterRight></tt>)</span>
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
—
|
|
1914
|
+
<div class='inline'>
|
|
1915
|
+
<p>Array of WaterRight objects.</p>
|
|
1916
|
+
</div>
|
|
1917
|
+
|
|
1918
|
+
</li>
|
|
1919
|
+
|
|
1920
|
+
</ul>
|
|
1921
|
+
<p class="tag_title">Raises:</p>
|
|
1922
|
+
<ul class="raise">
|
|
1923
|
+
|
|
1924
|
+
<li>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
—
|
|
1932
|
+
<div class='inline'>
|
|
1933
|
+
<p>If an invalid water rights type is provided.</p>
|
|
1934
|
+
</div>
|
|
1935
|
+
|
|
1936
|
+
</li>
|
|
1937
|
+
|
|
1938
|
+
</ul>
|
|
1939
|
+
|
|
1940
|
+
</div><table class="source_code">
|
|
1941
|
+
<tr>
|
|
1942
|
+
<td>
|
|
1943
|
+
<pre class="lines">
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
80
|
|
1947
|
+
81
|
|
1948
|
+
82</pre>
|
|
1949
|
+
</td>
|
|
1950
|
+
<td>
|
|
1951
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 80</span>
|
|
1952
|
+
|
|
1953
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_water_rights'>parse_water_rights</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span><span class='rparen'>)</span>
|
|
1954
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/WaterRightsParser.html" title="Cdss::Parsers::WaterRightsParser (module)">WaterRightsParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_water_rights'><span class='object_link'><a href="Parsers/WaterRightsParser.html#parse_water_rights-class_method" title="Cdss::Parsers::WaterRightsParser.parse_water_rights (method)">parse_water_rights</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
1955
|
+
<span class='kw'>end</span></pre>
|
|
1956
|
+
</td>
|
|
1957
|
+
</tr>
|
|
1958
|
+
</table>
|
|
1959
|
+
</div>
|
|
1960
|
+
|
|
1961
|
+
<div class="method_details ">
|
|
1962
|
+
<h3 class="signature " id="parse_well_measurements-class_method">
|
|
1963
|
+
|
|
1964
|
+
.<strong>parse_well_measurements</strong>(response) ⇒ <tt>Array<Reading></tt>
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
</h3><div class="docstring">
|
|
1971
|
+
<div class="discussion">
|
|
1972
|
+
|
|
1973
|
+
<p>Parses well measurement data from the API response.</p>
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
</div>
|
|
1977
|
+
</div>
|
|
1978
|
+
<div class="tags">
|
|
1979
|
+
|
|
1980
|
+
<div class="examples">
|
|
1981
|
+
<h4 class="tag_title">Examples:</h4>
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
<h5 class="example_title"><div class='inline'>
|
|
1985
|
+
<p>Parse well measurements</p>
|
|
1986
|
+
</div></h5>
|
|
1987
|
+
|
|
1988
|
+
<pre class="example code"><code><span class='id identifier rubyid_measurements'>measurements</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_well_measurements'>parse_well_measurements</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
1989
|
+
|
|
1990
|
+
</div>
|
|
1991
|
+
<p class="tag_title">Parameters:</p>
|
|
1992
|
+
<ul class="param">
|
|
1993
|
+
|
|
1994
|
+
<li>
|
|
1995
|
+
|
|
1996
|
+
<span class='name'>response</span>
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
—
|
|
2004
|
+
<div class='inline'>
|
|
2005
|
+
<p>The API response containing well measurement data.</p>
|
|
2006
|
+
</div>
|
|
2007
|
+
|
|
2008
|
+
</li>
|
|
2009
|
+
|
|
2010
|
+
</ul>
|
|
2011
|
+
|
|
2012
|
+
<p class="tag_title">Returns:</p>
|
|
2013
|
+
<ul class="return">
|
|
2014
|
+
|
|
2015
|
+
<li>
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
<span class='type'>(<tt>Array<Reading></tt>)</span>
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
—
|
|
2023
|
+
<div class='inline'>
|
|
2024
|
+
<p>Array of Reading objects containing well measurements.</p>
|
|
2025
|
+
</div>
|
|
2026
|
+
|
|
2027
|
+
</li>
|
|
2028
|
+
|
|
2029
|
+
</ul>
|
|
2030
|
+
|
|
2031
|
+
</div><table class="source_code">
|
|
2032
|
+
<tr>
|
|
2033
|
+
<td>
|
|
2034
|
+
<pre class="lines">
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
46
|
|
2038
|
+
47
|
|
2039
|
+
48</pre>
|
|
2040
|
+
</td>
|
|
2041
|
+
<td>
|
|
2042
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 46</span>
|
|
2043
|
+
|
|
2044
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_well_measurements'>parse_well_measurements</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
2045
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/WellParser.html" title="Cdss::Parsers::WellParser (module)">WellParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_well_measurements'><span class='object_link'><a href="Parsers/WellParser.html#parse_well_measurements-class_method" title="Cdss::Parsers::WellParser.parse_well_measurements (method)">parse_well_measurements</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
2046
|
+
<span class='kw'>end</span></pre>
|
|
2047
|
+
</td>
|
|
2048
|
+
</tr>
|
|
2049
|
+
</table>
|
|
2050
|
+
</div>
|
|
2051
|
+
|
|
2052
|
+
<div class="method_details ">
|
|
2053
|
+
<h3 class="signature " id="parse_wells-class_method">
|
|
2054
|
+
|
|
2055
|
+
.<strong>parse_wells</strong>(response) ⇒ <tt>Array<Well></tt>
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
</h3><div class="docstring">
|
|
2062
|
+
<div class="discussion">
|
|
2063
|
+
|
|
2064
|
+
<p>Parses well data from the API response.</p>
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
</div>
|
|
2068
|
+
</div>
|
|
2069
|
+
<div class="tags">
|
|
2070
|
+
|
|
2071
|
+
<div class="examples">
|
|
2072
|
+
<h4 class="tag_title">Examples:</h4>
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
<h5 class="example_title"><div class='inline'>
|
|
2076
|
+
<p>Parse wells from response</p>
|
|
2077
|
+
</div></h5>
|
|
2078
|
+
|
|
2079
|
+
<pre class="example code"><code><span class='id identifier rubyid_wells'>wells</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_wells'>parse_wells</span><span class='lparen'>(</span><span class='id identifier rubyid_response_data'>response_data</span><span class='rparen'>)</span></code></pre>
|
|
2080
|
+
|
|
2081
|
+
</div>
|
|
2082
|
+
<p class="tag_title">Parameters:</p>
|
|
2083
|
+
<ul class="param">
|
|
2084
|
+
|
|
2085
|
+
<li>
|
|
2086
|
+
|
|
2087
|
+
<span class='name'>response</span>
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
—
|
|
2095
|
+
<div class='inline'>
|
|
2096
|
+
<p>The API response containing well data.</p>
|
|
2097
|
+
</div>
|
|
2098
|
+
|
|
2099
|
+
</li>
|
|
2100
|
+
|
|
2101
|
+
</ul>
|
|
2102
|
+
|
|
2103
|
+
<p class="tag_title">Returns:</p>
|
|
2104
|
+
<ul class="return">
|
|
2105
|
+
|
|
2106
|
+
<li>
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
<span class='type'>(<tt>Array<Well></tt>)</span>
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
—
|
|
2114
|
+
<div class='inline'>
|
|
2115
|
+
<p>Array of Well objects with basic well information.</p>
|
|
2116
|
+
</div>
|
|
2117
|
+
|
|
2118
|
+
</li>
|
|
2119
|
+
|
|
2120
|
+
</ul>
|
|
2121
|
+
|
|
2122
|
+
</div><table class="source_code">
|
|
2123
|
+
<tr>
|
|
2124
|
+
<td>
|
|
2125
|
+
<pre class="lines">
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
36
|
|
2129
|
+
37
|
|
2130
|
+
38</pre>
|
|
2131
|
+
</td>
|
|
2132
|
+
<td>
|
|
2133
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/parser.rb', line 36</span>
|
|
2134
|
+
|
|
2135
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_wells'>parse_wells</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
2136
|
+
<span class='const'><span class='object_link'><a href="Parsers.html" title="Cdss::Parsers (module)">Parsers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Parsers/WellParser.html" title="Cdss::Parsers::WellParser (module)">WellParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_wells'><span class='object_link'><a href="Parsers/WellParser.html#parse_wells-class_method" title="Cdss::Parsers::WellParser.parse_wells (method)">parse_wells</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
|
2137
|
+
<span class='kw'>end</span></pre>
|
|
2138
|
+
</td>
|
|
2139
|
+
</tr>
|
|
2140
|
+
</table>
|
|
2141
|
+
</div>
|
|
2142
|
+
|
|
2143
|
+
</div>
|
|
2144
|
+
|
|
2145
|
+
</div>
|
|
2146
|
+
|
|
2147
|
+
<div id="footer">
|
|
2148
|
+
Generated on Thu Feb 20 21:19:08 2025 by
|
|
2149
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2150
|
+
0.9.37 (ruby-3.2.2).
|
|
2151
|
+
</div>
|
|
2152
|
+
|
|
2153
|
+
</div>
|
|
2154
|
+
</body>
|
|
2155
|
+
</html>
|