-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLogReadingAttributes.html
More file actions
406 lines (233 loc) · 9.95 KB
/
LogReadingAttributes.html
File metadata and controls
406 lines (233 loc) · 9.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Cdss::Concerns::LogReadingAttributes
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Cdss::Concerns::LogReadingAttributes";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (L)</a> »
<span class='title'><span class='object_link'><a href="../../Cdss.html" title="Cdss (module)">Cdss</a></span></span> » <span class='title'><span class='object_link'><a href="../Concerns.html" title="Cdss::Concerns (module)">Concerns</a></span></span>
»
<span class="title">LogReadingAttributes</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Cdss::Concerns::LogReadingAttributes
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Models/Reading.html" title="Cdss::Models::Reading (class)">Models::Reading</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/cdss/concerns/log_reading_attributes.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A concern module that adds log reading-related attributes to classes.</p>
<p>This module provides a set of standardized attributes for log reading data, including aquifer information, depth measurements, elevation, and comments. When included in a class, it dynamically adds accessor methods for these attributes.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<h5 class="example_title"><div class='inline'>
<p>Adding log reading attributes to a class</p>
</div></h5>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>WellLog</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../Cdss.html" title="Cdss (module)">Cdss</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Concerns.html" title="Cdss::Concerns (module)">Concerns</a></span></span><span class='op'>::</span><span class='const'>LogReadingAttributes</span>
<span class='kw'>end</span></code></pre>
</div>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="LOG_ATTRIBUTES-constant" class="">LOG_ATTRIBUTES =
<div class="docstring">
<div class="discussion">
<p>Predefined list of log reading attributes</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<Symbol></tt>)</span>
—
<div class='inline'>
<p>List of attributes related to log readings</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
</span><span class='tstring_content'>aquifer</span><span class='words_sep'>
</span><span class='tstring_content'>g_log_top_depth</span><span class='words_sep'>
</span><span class='tstring_content'>g_log_base_depth</span><span class='words_sep'>
</span><span class='tstring_content'>g_log_top_elev</span><span class='words_sep'>
</span><span class='tstring_content'>g_log_base_elev</span><span class='words_sep'>
</span><span class='tstring_content'>g_log_thickness</span><span class='words_sep'>
</span><span class='tstring_content'>comment</span><span class='words_sep'>
</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Dynamically adds accessor methods when the module is included in a class.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#log_reading%3F-instance_method" title="#log_reading? (instance method)">#<strong>log_reading?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Checks if the instance has log reading data.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="included-class_method">
.<strong>included</strong>(base) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Dynamically adds accessor methods when the module is included in a class</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>base</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>The class including this module</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/cdss/concerns/log_reading_attributes.rb', line 32</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
<span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span><span class='lparen'>(</span><span class='op'>*</span><span class='const'><span class='object_link'><a href="#LOG_ATTRIBUTES-constant" title="Cdss::Concerns::LogReadingAttributes::LOG_ATTRIBUTES (constant)">LOG_ATTRIBUTES</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="log_reading?-instance_method">
#<strong>log_reading?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if the instance has log reading data</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<h5 class="example_title"><div class='inline'>
<p>Check if a well log has reading data</p>
</div></h5>
<pre class="example code"><code><span class='id identifier rubyid_well_log'>well_log</span><span class='period'>.</span><span class='id identifier rubyid_log_reading?'>log_reading?</span> <span class='comment'># => true or false</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'>
<p>true if aquifer or log thickness is present, false otherwise</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/cdss/concerns/log_reading_attributes.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_log_reading?'>log_reading?</span>
<span class='op'>!</span><span class='id identifier rubyid_aquifer'>aquifer</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_g_log_thickness'>g_log_thickness</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Feb 27 21:52:29 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.2.2).
</div>
</div>
</body>
</html>