fcsparse 0.1.0 → 0.2.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.
@@ -0,0 +1,602 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: FCSParse::FCSParam
8
+
9
+ &mdash; Documentation by YARD 0.8.2.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (F)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../FCSParse.html" title="FCSParse (module)">FCSParse</a></span></span>
36
+ &raquo;
37
+ <span class="title">FCSParam</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: FCSParse::FCSParam
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">FCSParse::FCSParam</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/fcsparse/fcsevent.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Class representing a single parameter and its value in a single event.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+ <p class="tag_title">Author:</p>
113
+ <ul class="author">
114
+
115
+ <li>
116
+
117
+
118
+
119
+
120
+
121
+ <div class='inline'>
122
+ <p>Colin J. Fuller</p>
123
+ </div>
124
+
125
+ </li>
126
+
127
+ </ul>
128
+
129
+ </div>
130
+
131
+
132
+
133
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
134
+ <ul class="summary">
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#description-instance_method" title="#description (instance method)">- (Object) <strong>description</strong> </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"><div class='inline'>
157
+ <p>Returns the value of attribute description.</p>
158
+ </div></span>
159
+
160
+ </li>
161
+
162
+
163
+ <li class="public ">
164
+ <span class="summary_signature">
165
+
166
+ <a href="#limit-instance_method" title="#limit (instance method)">- (Object) <strong>limit</strong> </a>
167
+
168
+
169
+
170
+ </span>
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>Returns the value of attribute limit.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ <li class="public ">
191
+ <span class="summary_signature">
192
+
193
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
194
+
195
+
196
+
197
+ </span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>Returns the value of attribute name.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#value-instance_method" title="#value (instance method)">- (Object) <strong>value</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+ <span class="summary_desc"><div class='inline'>
238
+ <p>Returns the value of attribute value.</p>
239
+ </div></span>
240
+
241
+ </li>
242
+
243
+
244
+ </ul>
245
+
246
+
247
+
248
+
249
+
250
+ <h2>
251
+ Instance Method Summary
252
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
253
+ </h2>
254
+
255
+ <ul class="summary">
256
+
257
+ <li class="public ">
258
+ <span class="summary_signature">
259
+
260
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (FCSParam) <strong>initialize</strong>(name, description, value, limit) </a>
261
+
262
+
263
+
264
+ </span>
265
+
266
+
267
+ <span class="note title constructor">constructor</span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>Create a new parameter with specified information.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ </ul>
284
+
285
+
286
+ <div id="constructor_details" class="method_details_list">
287
+ <h2>Constructor Details</h2>
288
+
289
+ <div class="method_details first">
290
+ <h3 class="signature first" id="initialize-instance_method">
291
+
292
+ - (<tt><span class='object_link'><a href="" title="FCSParse::FCSParam (class)">FCSParam</a></span></tt>) <strong>initialize</strong>(name, description, value, limit)
293
+
294
+
295
+
296
+
297
+
298
+ </h3><div class="docstring">
299
+ <div class="discussion">
300
+
301
+ <p>Create a new parameter with specified information</p>
302
+
303
+
304
+ </div>
305
+ </div>
306
+ <div class="tags">
307
+ <p class="tag_title">Parameters:</p>
308
+ <ul class="param">
309
+
310
+ <li>
311
+
312
+ <span class='name'>name</span>
313
+
314
+
315
+ <span class='type'></span>
316
+
317
+
318
+
319
+ &mdash;
320
+ <div class='inline'>
321
+ <p>the name of the parameter</p>
322
+ </div>
323
+
324
+ </li>
325
+
326
+ <li>
327
+
328
+ <span class='name'>description</span>
329
+
330
+
331
+ <span class='type'></span>
332
+
333
+
334
+
335
+ &mdash;
336
+ <div class='inline'>
337
+ <p>a longer description of the parameter</p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ <li>
343
+
344
+ <span class='name'>value</span>
345
+
346
+
347
+ <span class='type'></span>
348
+
349
+
350
+
351
+ &mdash;
352
+ <div class='inline'>
353
+ <p>the value of the parameter</p>
354
+ </div>
355
+
356
+ </li>
357
+
358
+ <li>
359
+
360
+ <span class='name'>limit</span>
361
+
362
+
363
+ <span class='type'></span>
364
+
365
+
366
+
367
+ &mdash;
368
+ <div class='inline'>
369
+ <p>the maximum value that the parameter can take</p>
370
+ </div>
371
+
372
+ </li>
373
+
374
+ </ul>
375
+
376
+
377
+ </div><table class="source_code">
378
+ <tr>
379
+ <td>
380
+ <pre class="lines">
381
+
382
+
383
+ 49
384
+ 50
385
+ 51
386
+ 52
387
+ 53
388
+ 54
389
+ 55
390
+ 56</pre>
391
+ </td>
392
+ <td>
393
+ <pre class="code"><span class="info file"># File 'lib/fcsparse/fcsevent.rb', line 49</span>
394
+
395
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_name identifier id'>name</span><span class='comma token'>,</span> <span class='rubyid_description identifier id'>description</span><span class='comma token'>,</span> <span class='rubyid_value identifier id'>value</span><span class='comma token'>,</span> <span class='rubyid_limit identifier id'>limit</span><span class='rparen token'>)</span>
396
+
397
+ <span class='rubyid_@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='rubyid_name identifier id'>name</span>
398
+ <span class='rubyid_@description ivar id'>@description</span> <span class='assign token'>=</span> <span class='rubyid_description identifier id'>description</span>
399
+ <span class='rubyid_@value ivar id'>@value</span> <span class='assign token'>=</span> <span class='rubyid_value identifier id'>value</span>
400
+ <span class='rubyid_@limit ivar id'>@limit</span> <span class='assign token'>=</span> <span class='rubyid_limit identifier id'>limit</span>
401
+
402
+ <span class='rubyid_end end kw'>end</span>
403
+ </pre>
404
+ </td>
405
+ </tr>
406
+ </table>
407
+ </div>
408
+
409
+ </div>
410
+
411
+ <div id="instance_attr_details" class="attr_details">
412
+ <h2>Instance Attribute Details</h2>
413
+
414
+
415
+ <span id="description=-instance_method"></span>
416
+ <div class="method_details first">
417
+ <h3 class="signature first" id="description-instance_method">
418
+
419
+ - (<tt>Object</tt>) <strong>description</strong>
420
+
421
+
422
+
423
+
424
+
425
+ </h3><div class="docstring">
426
+ <div class="discussion">
427
+
428
+ <p>Returns the value of attribute description</p>
429
+
430
+
431
+ </div>
432
+ </div>
433
+ <div class="tags">
434
+
435
+
436
+ </div><table class="source_code">
437
+ <tr>
438
+ <td>
439
+ <pre class="lines">
440
+
441
+
442
+ 58
443
+ 59
444
+ 60</pre>
445
+ </td>
446
+ <td>
447
+ <pre class="code"><span class="info file"># File 'lib/fcsparse/fcsevent.rb', line 58</span>
448
+
449
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_description identifier id'>description</span>
450
+ <span class='rubyid_@description ivar id'>@description</span>
451
+ <span class='rubyid_end end kw'>end</span>
452
+ </pre>
453
+ </td>
454
+ </tr>
455
+ </table>
456
+ </div>
457
+
458
+
459
+ <span id="limit=-instance_method"></span>
460
+ <div class="method_details ">
461
+ <h3 class="signature " id="limit-instance_method">
462
+
463
+ - (<tt>Object</tt>) <strong>limit</strong>
464
+
465
+
466
+
467
+
468
+
469
+ </h3><div class="docstring">
470
+ <div class="discussion">
471
+
472
+ <p>Returns the value of attribute limit</p>
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+
479
+
480
+ </div><table class="source_code">
481
+ <tr>
482
+ <td>
483
+ <pre class="lines">
484
+
485
+
486
+ 58
487
+ 59
488
+ 60</pre>
489
+ </td>
490
+ <td>
491
+ <pre class="code"><span class="info file"># File 'lib/fcsparse/fcsevent.rb', line 58</span>
492
+
493
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_limit identifier id'>limit</span>
494
+ <span class='rubyid_@limit ivar id'>@limit</span>
495
+ <span class='rubyid_end end kw'>end</span>
496
+ </pre>
497
+ </td>
498
+ </tr>
499
+ </table>
500
+ </div>
501
+
502
+
503
+ <span id="name=-instance_method"></span>
504
+ <div class="method_details ">
505
+ <h3 class="signature " id="name-instance_method">
506
+
507
+ - (<tt>Object</tt>) <strong>name</strong>
508
+
509
+
510
+
511
+
512
+
513
+ </h3><div class="docstring">
514
+ <div class="discussion">
515
+
516
+ <p>Returns the value of attribute name</p>
517
+
518
+
519
+ </div>
520
+ </div>
521
+ <div class="tags">
522
+
523
+
524
+ </div><table class="source_code">
525
+ <tr>
526
+ <td>
527
+ <pre class="lines">
528
+
529
+
530
+ 58
531
+ 59
532
+ 60</pre>
533
+ </td>
534
+ <td>
535
+ <pre class="code"><span class="info file"># File 'lib/fcsparse/fcsevent.rb', line 58</span>
536
+
537
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_name identifier id'>name</span>
538
+ <span class='rubyid_@name ivar id'>@name</span>
539
+ <span class='rubyid_end end kw'>end</span>
540
+ </pre>
541
+ </td>
542
+ </tr>
543
+ </table>
544
+ </div>
545
+
546
+
547
+ <span id="value=-instance_method"></span>
548
+ <div class="method_details ">
549
+ <h3 class="signature " id="value-instance_method">
550
+
551
+ - (<tt>Object</tt>) <strong>value</strong>
552
+
553
+
554
+
555
+
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+ <p>Returns the value of attribute value</p>
561
+
562
+
563
+ </div>
564
+ </div>
565
+ <div class="tags">
566
+
567
+
568
+ </div><table class="source_code">
569
+ <tr>
570
+ <td>
571
+ <pre class="lines">
572
+
573
+
574
+ 58
575
+ 59
576
+ 60</pre>
577
+ </td>
578
+ <td>
579
+ <pre class="code"><span class="info file"># File 'lib/fcsparse/fcsevent.rb', line 58</span>
580
+
581
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_value identifier id'>value</span>
582
+ <span class='rubyid_@value ivar id'>@value</span>
583
+ <span class='rubyid_end end kw'>end</span>
584
+ </pre>
585
+ </td>
586
+ </tr>
587
+ </table>
588
+ </div>
589
+
590
+ </div>
591
+
592
+
593
+ </div>
594
+
595
+ <div id="footer">
596
+ Generated on Wed Jun 20 16:53:15 2012 by
597
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
598
+ 0.8.2.1 (ruby-1.8.7).
599
+ </div>
600
+
601
+ </body>
602
+ </html>