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,972 @@
|
|
|
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::Analysis
|
|
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::Analysis";
|
|
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 (A)</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">Analysis</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::Analysis
|
|
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/analysis.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 analysis services from the CDSS API including call analysis and water source route frameworks.</p>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
</div>
|
|
104
|
+
<div class="tags">
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Instance Method Summary
|
|
117
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<ul class="summary">
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#get_call_analysis_gnisid-instance_method" title="#get_call_analysis_gnisid (instance method)">#<strong>get_call_analysis_gnisid</strong>(gnis_id:, admin_no:, stream_mile:, start_date: nil, end_date: nil, batch: false) ⇒ Array<CallAnalysis> </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<span class="summary_desc"><div class='inline'>
|
|
140
|
+
<p>Performs call analysis by GNIS ID, showing daily priority percentages.</p>
|
|
141
|
+
</div></span>
|
|
142
|
+
|
|
143
|
+
</li>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<li class="public ">
|
|
147
|
+
<span class="summary_signature">
|
|
148
|
+
|
|
149
|
+
<a href="#get_call_analysis_wdid-instance_method" title="#get_call_analysis_wdid (instance method)">#<strong>get_call_analysis_wdid</strong>(wdid:, admin_no:, start_date: nil, end_date: nil, batch: false) ⇒ Array<CallAnalysis> </a>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</span>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="summary_desc"><div class='inline'>
|
|
164
|
+
<p>Performs call analysis by WDID, showing daily priority percentages.</p>
|
|
165
|
+
</div></span>
|
|
166
|
+
|
|
167
|
+
</li>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#get_source_route_analysis-instance_method" title="#get_source_route_analysis (instance method)">#<strong>get_source_route_analysis</strong>(lt_gnis_id:, lt_stream_mile:, ut_gnis_id:, ut_stream_mile:) ⇒ Array<RouteAnalysis> </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>Analyzes water source routes between two points.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<li class="public ">
|
|
195
|
+
<span class="summary_signature">
|
|
196
|
+
|
|
197
|
+
<a href="#get_source_route_framework-instance_method" title="#get_source_route_framework (instance method)">#<strong>get_source_route_framework</strong>(division: nil, gnis_name: nil, water_district: nil) ⇒ Array<SourceRoute> </a>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<span class="summary_desc"><div class='inline'>
|
|
212
|
+
<p>Retrieves the DWR source route framework reference data.</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</ul>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
|
|
231
|
+
<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>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<div id="instance_method_details" class="method_details_list">
|
|
235
|
+
<h2>Instance Method Details</h2>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<div class="method_details first">
|
|
239
|
+
<h3 class="signature first" id="get_call_analysis_gnisid-instance_method">
|
|
240
|
+
|
|
241
|
+
#<strong>get_call_analysis_gnisid</strong>(gnis_id:, admin_no:, stream_mile:, start_date: nil, end_date: nil, batch: false) ⇒ <tt>Array<CallAnalysis></tt>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</h3><div class="docstring">
|
|
248
|
+
<div class="discussion">
|
|
249
|
+
|
|
250
|
+
<p>Performs call analysis by GNIS ID, showing daily priority percentages.</p>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</div>
|
|
254
|
+
</div>
|
|
255
|
+
<div class="tags">
|
|
256
|
+
<p class="tag_title">Parameters:</p>
|
|
257
|
+
<ul class="param">
|
|
258
|
+
|
|
259
|
+
<li>
|
|
260
|
+
|
|
261
|
+
<span class='name'>gnis_id</span>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
—
|
|
269
|
+
<div class='inline'>
|
|
270
|
+
<p>GNIS ID to analyze.</p>
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
</li>
|
|
274
|
+
|
|
275
|
+
<li>
|
|
276
|
+
|
|
277
|
+
<span class='name'>admin_no</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class='type'>(<tt>String</tt>, <tt>Integer</tt>)</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
—
|
|
285
|
+
<div class='inline'>
|
|
286
|
+
<p>Water Right Administration Number.</p>
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
</li>
|
|
290
|
+
|
|
291
|
+
<li>
|
|
292
|
+
|
|
293
|
+
<span class='name'>stream_mile</span>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
—
|
|
301
|
+
<div class='inline'>
|
|
302
|
+
<p>Stream mile for the analysis point.</p>
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
<li>
|
|
308
|
+
|
|
309
|
+
<span class='name'>start_date</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
—
|
|
319
|
+
<div class='inline'>
|
|
320
|
+
<p>Start date for analysis data.</p>
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
<li>
|
|
326
|
+
|
|
327
|
+
<span class='name'>end_date</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
—
|
|
337
|
+
<div class='inline'>
|
|
338
|
+
<p>End date for analysis data.</p>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
</li>
|
|
342
|
+
|
|
343
|
+
<li>
|
|
344
|
+
|
|
345
|
+
<span class='name'>batch</span>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
—
|
|
355
|
+
<div class='inline'>
|
|
356
|
+
<p>Whether to break date range into yearly batches. Defaults to false.</p>
|
|
357
|
+
</div>
|
|
358
|
+
|
|
359
|
+
</li>
|
|
360
|
+
|
|
361
|
+
</ul>
|
|
362
|
+
|
|
363
|
+
<p class="tag_title">Returns:</p>
|
|
364
|
+
<ul class="return">
|
|
365
|
+
|
|
366
|
+
<li>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<span class='type'>(<tt>Array<CallAnalysis></tt>)</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
—
|
|
374
|
+
<div class='inline'>
|
|
375
|
+
<p>Array of call analysis records.</p>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
</li>
|
|
379
|
+
|
|
380
|
+
</ul>
|
|
381
|
+
|
|
382
|
+
</div><table class="source_code">
|
|
383
|
+
<tr>
|
|
384
|
+
<td>
|
|
385
|
+
<pre class="lines">
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
57
|
|
389
|
+
58
|
|
390
|
+
59
|
|
391
|
+
60
|
|
392
|
+
61
|
|
393
|
+
62
|
|
394
|
+
63
|
|
395
|
+
64
|
|
396
|
+
65
|
|
397
|
+
66
|
|
398
|
+
67
|
|
399
|
+
68
|
|
400
|
+
69
|
|
401
|
+
70
|
|
402
|
+
71
|
|
403
|
+
72
|
|
404
|
+
73
|
|
405
|
+
74
|
|
406
|
+
75
|
|
407
|
+
76
|
|
408
|
+
77
|
|
409
|
+
78
|
|
410
|
+
79
|
|
411
|
+
80
|
|
412
|
+
81
|
|
413
|
+
82
|
|
414
|
+
83
|
|
415
|
+
84
|
|
416
|
+
85
|
|
417
|
+
86</pre>
|
|
418
|
+
</td>
|
|
419
|
+
<td>
|
|
420
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/analysis.rb', line 57</span>
|
|
421
|
+
|
|
422
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_call_analysis_gnisid'>get_call_analysis_gnisid</span><span class='lparen'>(</span><span class='label'>gnis_id:</span><span class='comma'>,</span> <span class='label'>admin_no:</span><span class='comma'>,</span> <span class='label'>stream_mile:</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'>batch:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
423
|
+
<span class='id identifier rubyid_admin_no'>admin_no</span> <span class='op'>=</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
424
|
+
|
|
425
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_batch'>batch</span>
|
|
426
|
+
<span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
427
|
+
<span class='id identifier rubyid_date_ranges'>date_ranges</span> <span class='op'>=</span> <span class='id identifier rubyid_batch_dates'>batch_dates</span><span class='lparen'>(</span><span class='id identifier rubyid_start_date'>start_date</span><span class='comma'>,</span> <span class='id identifier rubyid_end_date'>end_date</span><span class='rparen'>)</span>
|
|
428
|
+
|
|
429
|
+
<span class='id identifier rubyid_date_ranges'>date_ranges</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_range'>range</span><span class='comma'>,</span> <span class='id identifier rubyid__index'>_index</span><span class='op'>|</span>
|
|
430
|
+
<span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span>
|
|
431
|
+
<span class='id identifier rubyid_fetch_call_analysis_gnisid'>fetch_call_analysis_gnisid</span><span class='lparen'>(</span>
|
|
432
|
+
<span class='label'>gnis_id:</span> <span class='id identifier rubyid_gnis_id'>gnis_id</span><span class='comma'>,</span>
|
|
433
|
+
<span class='label'>admin_no:</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='comma'>,</span>
|
|
434
|
+
<span class='label'>stream_mile:</span> <span class='id identifier rubyid_stream_mile'>stream_mile</span><span class='comma'>,</span>
|
|
435
|
+
<span class='label'>start_date:</span> <span class='id identifier rubyid_range'>range</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
436
|
+
<span class='label'>end_date:</span> <span class='id identifier rubyid_range'>range</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
|
437
|
+
<span class='rparen'>)</span>
|
|
438
|
+
<span class='rparen'>)</span>
|
|
439
|
+
<span class='kw'>end</span>
|
|
440
|
+
|
|
441
|
+
<span class='id identifier rubyid_results'>results</span>
|
|
442
|
+
<span class='kw'>else</span>
|
|
443
|
+
<span class='id identifier rubyid_fetch_call_analysis_gnisid'>fetch_call_analysis_gnisid</span><span class='lparen'>(</span>
|
|
444
|
+
<span class='label'>gnis_id:</span> <span class='id identifier rubyid_gnis_id'>gnis_id</span><span class='comma'>,</span>
|
|
445
|
+
<span class='label'>admin_no:</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='comma'>,</span>
|
|
446
|
+
<span class='label'>stream_mile:</span> <span class='id identifier rubyid_stream_mile'>stream_mile</span><span class='comma'>,</span>
|
|
447
|
+
<span class='label'>start_date:</span> <span class='id identifier rubyid_start_date'>start_date</span><span class='comma'>,</span>
|
|
448
|
+
<span class='label'>end_date:</span> <span class='id identifier rubyid_end_date'>end_date</span>
|
|
449
|
+
<span class='rparen'>)</span>
|
|
450
|
+
<span class='kw'>end</span>
|
|
451
|
+
<span class='kw'>end</span></pre>
|
|
452
|
+
</td>
|
|
453
|
+
</tr>
|
|
454
|
+
</table>
|
|
455
|
+
</div>
|
|
456
|
+
|
|
457
|
+
<div class="method_details ">
|
|
458
|
+
<h3 class="signature " id="get_call_analysis_wdid-instance_method">
|
|
459
|
+
|
|
460
|
+
#<strong>get_call_analysis_wdid</strong>(wdid:, admin_no:, start_date: nil, end_date: nil, batch: false) ⇒ <tt>Array<CallAnalysis></tt>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</h3><div class="docstring">
|
|
467
|
+
<div class="discussion">
|
|
468
|
+
|
|
469
|
+
<p>Performs call analysis by WDID, showing daily priority percentages.</p>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tags">
|
|
475
|
+
|
|
476
|
+
<div class="examples">
|
|
477
|
+
<h4 class="tag_title">Examples:</h4>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<h5 class="example_title"><div class='inline'>
|
|
481
|
+
<p>Analyze calls for a specific WDID</p>
|
|
482
|
+
</div></h5>
|
|
483
|
+
|
|
484
|
+
<pre class="example code"><code><span class='id identifier rubyid_get_call_analysis_wdid'>get_call_analysis_wdid</span><span class='lparen'>(</span><span class='label'>wdid:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0301234</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>admin_no:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>12345.00000</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
<p class="tag_title">Parameters:</p>
|
|
488
|
+
<ul class="param">
|
|
489
|
+
|
|
490
|
+
<li>
|
|
491
|
+
|
|
492
|
+
<span class='name'>wdid</span>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
—
|
|
500
|
+
<div class='inline'>
|
|
501
|
+
<p>DWR WDID unique structure identifier code.</p>
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
<li>
|
|
507
|
+
|
|
508
|
+
<span class='name'>admin_no</span>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
<span class='type'>(<tt>String</tt>, <tt>Integer</tt>)</span>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
—
|
|
516
|
+
<div class='inline'>
|
|
517
|
+
<p>Water Right Administration Number.</p>
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
</li>
|
|
521
|
+
|
|
522
|
+
<li>
|
|
523
|
+
|
|
524
|
+
<span class='name'>start_date</span>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
—
|
|
534
|
+
<div class='inline'>
|
|
535
|
+
<p>Start date for analysis data.</p>
|
|
536
|
+
</div>
|
|
537
|
+
|
|
538
|
+
</li>
|
|
539
|
+
|
|
540
|
+
<li>
|
|
541
|
+
|
|
542
|
+
<span class='name'>end_date</span>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
—
|
|
552
|
+
<div class='inline'>
|
|
553
|
+
<p>End date for analysis data.</p>
|
|
554
|
+
</div>
|
|
555
|
+
|
|
556
|
+
</li>
|
|
557
|
+
|
|
558
|
+
<li>
|
|
559
|
+
|
|
560
|
+
<span class='name'>batch</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
—
|
|
570
|
+
<div class='inline'>
|
|
571
|
+
<p>Whether to break date range into yearly batches. Defaults to false.</p>
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
</li>
|
|
575
|
+
|
|
576
|
+
</ul>
|
|
577
|
+
|
|
578
|
+
<p class="tag_title">Returns:</p>
|
|
579
|
+
<ul class="return">
|
|
580
|
+
|
|
581
|
+
<li>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
<span class='type'>(<tt>Array<CallAnalysis></tt>)</span>
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
—
|
|
589
|
+
<div class='inline'>
|
|
590
|
+
<p>Array of call analysis records.</p>
|
|
591
|
+
</div>
|
|
592
|
+
|
|
593
|
+
</li>
|
|
594
|
+
|
|
595
|
+
</ul>
|
|
596
|
+
|
|
597
|
+
</div><table class="source_code">
|
|
598
|
+
<tr>
|
|
599
|
+
<td>
|
|
600
|
+
<pre class="lines">
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
19
|
|
604
|
+
20
|
|
605
|
+
21
|
|
606
|
+
22
|
|
607
|
+
23
|
|
608
|
+
24
|
|
609
|
+
25
|
|
610
|
+
26
|
|
611
|
+
27
|
|
612
|
+
28
|
|
613
|
+
29
|
|
614
|
+
30
|
|
615
|
+
31
|
|
616
|
+
32
|
|
617
|
+
33
|
|
618
|
+
34
|
|
619
|
+
35
|
|
620
|
+
36
|
|
621
|
+
37
|
|
622
|
+
38
|
|
623
|
+
39
|
|
624
|
+
40
|
|
625
|
+
41
|
|
626
|
+
42
|
|
627
|
+
43
|
|
628
|
+
44
|
|
629
|
+
45
|
|
630
|
+
46</pre>
|
|
631
|
+
</td>
|
|
632
|
+
<td>
|
|
633
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/analysis.rb', line 19</span>
|
|
634
|
+
|
|
635
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_call_analysis_wdid'>get_call_analysis_wdid</span><span class='lparen'>(</span><span class='label'>wdid:</span><span class='comma'>,</span> <span class='label'>admin_no:</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'>batch:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
636
|
+
<span class='id identifier rubyid_admin_no'>admin_no</span> <span class='op'>=</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
637
|
+
|
|
638
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_batch'>batch</span>
|
|
639
|
+
<span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
640
|
+
<span class='id identifier rubyid_date_ranges'>date_ranges</span> <span class='op'>=</span> <span class='id identifier rubyid_batch_dates'>batch_dates</span><span class='lparen'>(</span><span class='id identifier rubyid_start_date'>start_date</span><span class='comma'>,</span> <span class='id identifier rubyid_end_date'>end_date</span><span class='rparen'>)</span>
|
|
641
|
+
|
|
642
|
+
<span class='id identifier rubyid_date_ranges'>date_ranges</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_range'>range</span><span class='comma'>,</span> <span class='id identifier rubyid__index'>_index</span><span class='op'>|</span>
|
|
643
|
+
<span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span>
|
|
644
|
+
<span class='id identifier rubyid_fetch_call_analysis_wdid'>fetch_call_analysis_wdid</span><span class='lparen'>(</span>
|
|
645
|
+
<span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span><span class='comma'>,</span>
|
|
646
|
+
<span class='label'>admin_no:</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='comma'>,</span>
|
|
647
|
+
<span class='label'>start_date:</span> <span class='id identifier rubyid_range'>range</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
648
|
+
<span class='label'>end_date:</span> <span class='id identifier rubyid_range'>range</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
|
649
|
+
<span class='rparen'>)</span>
|
|
650
|
+
<span class='rparen'>)</span>
|
|
651
|
+
<span class='kw'>end</span>
|
|
652
|
+
|
|
653
|
+
<span class='id identifier rubyid_results'>results</span>
|
|
654
|
+
<span class='kw'>else</span>
|
|
655
|
+
<span class='id identifier rubyid_fetch_call_analysis_wdid'>fetch_call_analysis_wdid</span><span class='lparen'>(</span>
|
|
656
|
+
<span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span><span class='comma'>,</span>
|
|
657
|
+
<span class='label'>admin_no:</span> <span class='id identifier rubyid_admin_no'>admin_no</span><span class='comma'>,</span>
|
|
658
|
+
<span class='label'>start_date:</span> <span class='id identifier rubyid_start_date'>start_date</span><span class='comma'>,</span>
|
|
659
|
+
<span class='label'>end_date:</span> <span class='id identifier rubyid_end_date'>end_date</span>
|
|
660
|
+
<span class='rparen'>)</span>
|
|
661
|
+
<span class='kw'>end</span>
|
|
662
|
+
<span class='kw'>end</span></pre>
|
|
663
|
+
</td>
|
|
664
|
+
</tr>
|
|
665
|
+
</table>
|
|
666
|
+
</div>
|
|
667
|
+
|
|
668
|
+
<div class="method_details ">
|
|
669
|
+
<h3 class="signature " id="get_source_route_analysis-instance_method">
|
|
670
|
+
|
|
671
|
+
#<strong>get_source_route_analysis</strong>(lt_gnis_id:, lt_stream_mile:, ut_gnis_id:, ut_stream_mile:) ⇒ <tt>Array<RouteAnalysis></tt>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
</h3><div class="docstring">
|
|
678
|
+
<div class="discussion">
|
|
679
|
+
|
|
680
|
+
<p>Analyzes water source routes between two points.</p>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
</div>
|
|
684
|
+
</div>
|
|
685
|
+
<div class="tags">
|
|
686
|
+
<p class="tag_title">Parameters:</p>
|
|
687
|
+
<ul class="param">
|
|
688
|
+
|
|
689
|
+
<li>
|
|
690
|
+
|
|
691
|
+
<span class='name'>lt_gnis_id</span>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
—
|
|
699
|
+
<div class='inline'>
|
|
700
|
+
<p>Lower terminus GNIS ID.</p>
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
</li>
|
|
704
|
+
|
|
705
|
+
<li>
|
|
706
|
+
|
|
707
|
+
<span class='name'>lt_stream_mile</span>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
—
|
|
715
|
+
<div class='inline'>
|
|
716
|
+
<p>Lower terminus stream mile.</p>
|
|
717
|
+
</div>
|
|
718
|
+
|
|
719
|
+
</li>
|
|
720
|
+
|
|
721
|
+
<li>
|
|
722
|
+
|
|
723
|
+
<span class='name'>ut_gnis_id</span>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
—
|
|
731
|
+
<div class='inline'>
|
|
732
|
+
<p>Upper terminus GNIS ID.</p>
|
|
733
|
+
</div>
|
|
734
|
+
|
|
735
|
+
</li>
|
|
736
|
+
|
|
737
|
+
<li>
|
|
738
|
+
|
|
739
|
+
<span class='name'>ut_stream_mile</span>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
—
|
|
747
|
+
<div class='inline'>
|
|
748
|
+
<p>Upper terminus stream mile.</p>
|
|
749
|
+
</div>
|
|
750
|
+
|
|
751
|
+
</li>
|
|
752
|
+
|
|
753
|
+
</ul>
|
|
754
|
+
|
|
755
|
+
<p class="tag_title">Returns:</p>
|
|
756
|
+
<ul class="return">
|
|
757
|
+
|
|
758
|
+
<li>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
<span class='type'>(<tt>Array<RouteAnalysis></tt>)</span>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
—
|
|
766
|
+
<div class='inline'>
|
|
767
|
+
<p>Array of route analysis records.</p>
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
</li>
|
|
771
|
+
|
|
772
|
+
</ul>
|
|
773
|
+
|
|
774
|
+
</div><table class="source_code">
|
|
775
|
+
<tr>
|
|
776
|
+
<td>
|
|
777
|
+
<pre class="lines">
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
117
|
|
781
|
+
118
|
|
782
|
+
119
|
|
783
|
+
120
|
|
784
|
+
121
|
|
785
|
+
122
|
|
786
|
+
123
|
|
787
|
+
124
|
|
788
|
+
125
|
|
789
|
+
126
|
|
790
|
+
127
|
|
791
|
+
128
|
|
792
|
+
129
|
|
793
|
+
130
|
|
794
|
+
131</pre>
|
|
795
|
+
</td>
|
|
796
|
+
<td>
|
|
797
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/analysis.rb', line 117</span>
|
|
798
|
+
|
|
799
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_source_route_analysis'>get_source_route_analysis</span><span class='lparen'>(</span><span class='label'>lt_gnis_id:</span><span class='comma'>,</span> <span class='label'>lt_stream_mile:</span><span class='comma'>,</span> <span class='label'>ut_gnis_id:</span><span class='comma'>,</span> <span class='label'>ut_stream_mile:</span><span class='rparen'>)</span>
|
|
800
|
+
<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>
|
|
801
|
+
<span class='lbrace'>{</span>
|
|
802
|
+
<span class='label'>ltGnisId:</span> <span class='id identifier rubyid_lt_gnis_id'>lt_gnis_id</span><span class='comma'>,</span>
|
|
803
|
+
<span class='label'>ltStreamMile:</span> <span class='id identifier rubyid_lt_stream_mile'>lt_stream_mile</span><span class='comma'>,</span>
|
|
804
|
+
<span class='label'>utGnisId:</span> <span class='id identifier rubyid_ut_gnis_id'>ut_gnis_id</span><span class='comma'>,</span>
|
|
805
|
+
<span class='label'>utStreamMile:</span> <span class='id identifier rubyid_ut_stream_mile'>ut_stream_mile</span>
|
|
806
|
+
<span class='rbrace'>}</span>
|
|
807
|
+
<span class='rparen'>)</span>
|
|
808
|
+
|
|
809
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
|
810
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/analysisservices/watersourcerouteanalysis/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
811
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
|
812
|
+
<span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <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_route_analyses'><span class='object_link'><a href="Parser.html#parse_route_analyses-class_method" title="Cdss::Parser.parse_route_analyses (method)">parse_route_analyses</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
813
|
+
<span class='kw'>end</span></pre>
|
|
814
|
+
</td>
|
|
815
|
+
</tr>
|
|
816
|
+
</table>
|
|
817
|
+
</div>
|
|
818
|
+
|
|
819
|
+
<div class="method_details ">
|
|
820
|
+
<h3 class="signature " id="get_source_route_framework-instance_method">
|
|
821
|
+
|
|
822
|
+
#<strong>get_source_route_framework</strong>(division: nil, gnis_name: nil, water_district: nil) ⇒ <tt>Array<SourceRoute></tt>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
</h3><div class="docstring">
|
|
829
|
+
<div class="discussion">
|
|
830
|
+
|
|
831
|
+
<p>Retrieves the DWR source route framework reference data.</p>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
</div>
|
|
835
|
+
</div>
|
|
836
|
+
<div class="tags">
|
|
837
|
+
<p class="tag_title">Parameters:</p>
|
|
838
|
+
<ul class="param">
|
|
839
|
+
|
|
840
|
+
<li>
|
|
841
|
+
|
|
842
|
+
<span class='name'>division</span>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
—
|
|
852
|
+
<div class='inline'>
|
|
853
|
+
<p>Water division to filter by.</p>
|
|
854
|
+
</div>
|
|
855
|
+
|
|
856
|
+
</li>
|
|
857
|
+
|
|
858
|
+
<li>
|
|
859
|
+
|
|
860
|
+
<span class='name'>gnis_name</span>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
—
|
|
870
|
+
<div class='inline'>
|
|
871
|
+
<p>GNIS Name to filter by.</p>
|
|
872
|
+
</div>
|
|
873
|
+
|
|
874
|
+
</li>
|
|
875
|
+
|
|
876
|
+
<li>
|
|
877
|
+
|
|
878
|
+
<span class='name'>water_district</span>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
—
|
|
888
|
+
<div class='inline'>
|
|
889
|
+
<p>Water district to filter by.</p>
|
|
890
|
+
</div>
|
|
891
|
+
|
|
892
|
+
</li>
|
|
893
|
+
|
|
894
|
+
</ul>
|
|
895
|
+
|
|
896
|
+
<p class="tag_title">Returns:</p>
|
|
897
|
+
<ul class="return">
|
|
898
|
+
|
|
899
|
+
<li>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
<span class='type'>(<tt>Array<SourceRoute></tt>)</span>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
—
|
|
907
|
+
<div class='inline'>
|
|
908
|
+
<p>Array of source route framework records.</p>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
</li>
|
|
912
|
+
|
|
913
|
+
</ul>
|
|
914
|
+
|
|
915
|
+
</div><table class="source_code">
|
|
916
|
+
<tr>
|
|
917
|
+
<td>
|
|
918
|
+
<pre class="lines">
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
94
|
|
922
|
+
95
|
|
923
|
+
96
|
|
924
|
+
97
|
|
925
|
+
98
|
|
926
|
+
99
|
|
927
|
+
100
|
|
928
|
+
101
|
|
929
|
+
102
|
|
930
|
+
103
|
|
931
|
+
104
|
|
932
|
+
105
|
|
933
|
+
106
|
|
934
|
+
107
|
|
935
|
+
108</pre>
|
|
936
|
+
</td>
|
|
937
|
+
<td>
|
|
938
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/analysis.rb', line 94</span>
|
|
939
|
+
|
|
940
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_source_route_framework'>get_source_route_framework</span><span class='lparen'>(</span><span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>gnis_name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
941
|
+
<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>
|
|
942
|
+
<span class='lbrace'>{</span>
|
|
943
|
+
<span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
944
|
+
<span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
|
|
945
|
+
<span class='label'>gnisName:</span> <span class='id identifier rubyid_gnis_name'>gnis_name</span><span class='comma'>,</span>
|
|
946
|
+
<span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span>
|
|
947
|
+
<span class='rbrace'>}</span>
|
|
948
|
+
<span class='rparen'>)</span>
|
|
949
|
+
|
|
950
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
|
951
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/analysisservices/watersourcerouteframework/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
952
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
|
953
|
+
<span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <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_source_routes'><span class='object_link'><a href="Parser.html#parse_source_routes-class_method" title="Cdss::Parser.parse_source_routes (method)">parse_source_routes</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
954
|
+
<span class='kw'>end</span></pre>
|
|
955
|
+
</td>
|
|
956
|
+
</tr>
|
|
957
|
+
</table>
|
|
958
|
+
</div>
|
|
959
|
+
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
<div id="footer">
|
|
965
|
+
Generated on Thu Feb 20 21:19:08 2025 by
|
|
966
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
967
|
+
0.9.37 (ruby-3.2.2).
|
|
968
|
+
</div>
|
|
969
|
+
|
|
970
|
+
</div>
|
|
971
|
+
</body>
|
|
972
|
+
</html>
|