sdl4r 0.9.9 → 0.9.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (81) hide show
  1. data/CHANGELOG +70 -1
  2. data/LICENSE +499 -497
  3. data/Rakefile +38 -28
  4. data/TODO +194 -45
  5. data/doc/classes/SDL4R/AbbreviationTimezoneProxy.html +151 -0
  6. data/doc/classes/SDL4R/ConstantTimezone.html +129 -0
  7. data/doc/classes/SDL4R/Element.html +148 -0
  8. data/doc/classes/SDL4R/Reader.html +683 -0
  9. data/doc/classes/SDL4R/RelativeTimezone.html +187 -0
  10. data/doc/classes/SDL4R/SdlBinary.html +188 -0
  11. data/doc/classes/SDL4R/SdlParseError.html +110 -0
  12. data/doc/classes/SDL4R/SdlTimeSpan.html +651 -0
  13. data/doc/classes/SDL4R/Serializer.html +557 -0
  14. data/doc/classes/SDL4R/Serializer/Ref.html +138 -0
  15. data/doc/classes/SDL4R/TZAbbreviationDB/Record.html +117 -0
  16. data/doc/classes/SDL4R/Tag.html +1274 -0
  17. data/doc/classes/SDL4R/Token.html +131 -0
  18. data/doc/created.rid +1 -0
  19. data/doc/files/CHANGELOG.html +290 -0
  20. data/doc/files/LICENSE.html +53 -0
  21. data/doc/files/README.html +405 -0
  22. data/doc/files/lib/sdl4r/abbreviation_timezone_proxy_rb.html +63 -0
  23. data/doc/files/lib/sdl4r/constant_timezone_rb.html +54 -0
  24. data/doc/files/lib/sdl4r/element_rb.html +54 -0
  25. data/doc/files/lib/sdl4r/reader_rb.html +68 -0
  26. data/doc/files/lib/sdl4r/relative_timezone_rb.html +62 -0
  27. data/doc/files/lib/sdl4r/sdl4r_rb.html +66 -0
  28. data/doc/files/lib/sdl4r/sdl4r_tzinfo_rb.html +64 -0
  29. data/doc/files/lib/sdl4r/sdl4r_version_rb.html +54 -0
  30. data/doc/files/lib/sdl4r/sdl_binary_rb.html +54 -0
  31. data/doc/files/lib/sdl4r/sdl_parse_error_rb.html +54 -0
  32. data/doc/files/lib/sdl4r/sdl_time_span_rb.html +54 -0
  33. data/doc/files/lib/sdl4r/serializer_rb.html +62 -0
  34. data/doc/files/lib/sdl4r/tag_rb.html +66 -0
  35. data/doc/files/lib/sdl4r/token_rb.html +54 -0
  36. data/doc/files/lib/sdl4r/tokenizer_rb.html +64 -0
  37. data/doc/files/lib/sdl4r/tz_abbreviation_db_rb.html +67 -0
  38. data/doc/files/lib/sdl4r_rb.html +54 -0
  39. data/doc/files/lib/sdl4r_tzinfo_rb.html +54 -0
  40. data/doc/fr_class_index.html +23 -0
  41. data/doc/fr_file_index.html +40 -0
  42. data/doc/fr_method_index.html +4711 -0
  43. data/doc/index.html +15 -0
  44. data/doc/rdoc-style.css +328 -0
  45. data/lib/sdl4r.rb +3 -1
  46. data/lib/sdl4r/abbreviation_timezone_proxy.rb +38 -0
  47. data/lib/sdl4r/constant_timezone.rb +58 -0
  48. data/{test/sdl4r/sdl_test.rb → lib/sdl4r/element.rb} +19 -14
  49. data/lib/sdl4r/reader.rb +772 -0
  50. data/lib/sdl4r/relative_timezone.rb +156 -0
  51. data/lib/sdl4r/sdl4r.rb +187 -45
  52. data/lib/sdl4r/sdl4r_tzinfo.rb +75 -0
  53. data/lib/sdl4r/sdl4r_version.rb +24 -0
  54. data/lib/sdl4r/sdl_parse_error.rb +1 -1
  55. data/lib/sdl4r/sdl_time_span.rb +5 -1
  56. data/lib/sdl4r/serializer.rb +473 -60
  57. data/lib/sdl4r/tag.rb +126 -51
  58. data/lib/sdl4r/token.rb +49 -0
  59. data/lib/sdl4r/tokenizer.rb +431 -0
  60. data/lib/sdl4r/tz_abbreviation_db.rb +266 -0
  61. data/read_jprof.html +16934 -0
  62. data/read_jprof_pull.html +14451 -0
  63. data/read_prof.html +4983 -0
  64. data/read_prof_pull.html +4896 -0
  65. data/test/sdl4r/parser_test.rb +577 -503
  66. data/test/sdl4r/read_jprof.rb +58 -0
  67. data/test/sdl4r/read_prof.rb +70 -0
  68. data/test/sdl4r/reader_test.rb +173 -0
  69. data/test/sdl4r/relative_timezone_test.rb +102 -0
  70. data/test/sdl4r/sdl4r_test.rb +611 -528
  71. data/test/sdl4r/sdl4r_tzinfo_test.rb +108 -0
  72. data/test/sdl4r/sdl_test_case.rb +60 -0
  73. data/test/sdl4r/serializer_test.rb +448 -11
  74. data/test/sdl4r/tag_test.rb +84 -5
  75. data/test/sdl4r/tokenizer_test.rb +128 -0
  76. metadata +69 -11
  77. data/lib/sdl4r/parser.rb +0 -648
  78. data/lib/sdl4r/parser/reader.rb +0 -184
  79. data/lib/sdl4r/parser/time_span_with_zone.rb +0 -57
  80. data/lib/sdl4r/parser/token.rb +0 -138
  81. data/lib/sdl4r/parser/tokenizer.rb +0 -507
@@ -0,0 +1,651 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
+ <html lang='en'>
3
+ <head>
4
+ <title>: SDL4R::SdlTimeSpan [RDoc: Simple Declarative Language for Ruby]</title>
5
+ <meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
6
+ <link href='../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
7
+ <script type='text/javascript'>
8
+ //<![CDATA[
9
+ function popupCode(url) {
10
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
11
+ }
12
+
13
+ function toggleCode(id) {
14
+ var code = document.getElementById(id)
15
+
16
+ code.style.display = code.style.display != 'block' ? 'block' : 'none'
17
+ return true
18
+ }
19
+
20
+ // Make codeblocks hidden by default
21
+ document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
22
+ //]]>
23
+ </script>
24
+ </head>
25
+ <body class='page'>
26
+ <div class='class' id='wrapper'>
27
+ <div class='header'>
28
+ <h1 class='name'>
29
+ <span class='type'>Class</span>
30
+ SDL4R::SdlTimeSpan
31
+ </h1>
32
+ <ol class='paths'>
33
+ <li>
34
+ <a href="../../files/lib/sdl4r/sdl_time_span_rb.html">lib/sdl4r/sdl_time_span.rb</a>
35
+ </li>
36
+ </ol>
37
+ <div class='parent'>
38
+ Parent:
39
+ <strong>Object</strong>
40
+ </div>
41
+ </div>
42
+ <div id='content'>
43
+ <div id='text'>
44
+ <div id='description'>
45
+ <p>
46
+ Represents a period of time (duration) as opposed to a particular moment in
47
+ time (which would be represented using a Date, DateTime or Time instance).
48
+ </p>
49
+ </div>
50
+ <div id='method-list'>
51
+ <h2>Methods</h2>
52
+ <h3>public class</h3>
53
+ <ol>
54
+ <li><a href="#M000055">new</a></li>
55
+ </ol>
56
+ <h3>public instance</h3>
57
+ <ol>
58
+ <li><a href="#M000081">&lt;=&gt;</a></li>
59
+ <li><a href="#M000080">==</a></li>
60
+ <li><a href="#M000058">day</a></li>
61
+ <li><a href="#M000057">days</a></li>
62
+ <li><a href="#M000079">eql?</a></li>
63
+ <li><a href="#M000078">hash</a></li>
64
+ <li><a href="#M000060">hour</a></li>
65
+ <li><a href="#M000059">hours</a></li>
66
+ <li><a href="#M000065">milliseconds</a></li>
67
+ <li><a href="#M000062">min</a></li>
68
+ <li><a href="#M000061">minutes</a></li>
69
+ <li><a href="#M000066">msec</a></li>
70
+ <li><a href="#M000072">negate</a></li>
71
+ <li><a href="#M000073">roll_days</a></li>
72
+ <li><a href="#M000074">roll_hours</a></li>
73
+ <li><a href="#M000077">roll_milliseconds</a></li>
74
+ <li><a href="#M000075">roll_minutes</a></li>
75
+ <li><a href="#M000076">roll_seconds</a></li>
76
+ <li><a href="#M000064">sec</a></li>
77
+ <li><a href="#M000063">seconds</a></li>
78
+ <li><a href="#M000056">sign</a></li>
79
+ <li><a href="#M000082">to_s</a></li>
80
+ <li><a href="#M000068">total_hours</a></li>
81
+ <li><a href="#M000071">total_milliseconds</a></li>
82
+ <li><a href="#M000069">total_minutes</a></li>
83
+ <li><a href="#M000070">total_seconds</a></li>
84
+ <li><a href="#M000067">usec</a></li>
85
+ </ol>
86
+ </div>
87
+ <div id='context'>
88
+ <div id='includes'>
89
+ <h2>Included modules</h2>
90
+ <ol>
91
+ <li>Comparable</li>
92
+ </ol>
93
+ </div>
94
+ </div>
95
+ <div id='section'>
96
+ <div id='constants-list'>
97
+ <h2>Constants</h2>
98
+ <div class='name-list'>
99
+ <table summary='Constants'>
100
+ <tr class='top-aligned-row context-row'>
101
+ <td class='context-item-name'>MILLISECONDS_IN_SECOND</td>
102
+ <td>=</td>
103
+ <td class='context-item-value'>1000</td>
104
+ </tr>
105
+ <tr class='top-aligned-row context-row'>
106
+ <td class='context-item-name'>MILLISECONDS_IN_MINUTE</td>
107
+ <td>=</td>
108
+ <td class='context-item-value'>60 * MILLISECONDS_IN_SECOND</td>
109
+ </tr>
110
+ <tr class='top-aligned-row context-row'>
111
+ <td class='context-item-name'>MILLISECONDS_IN_HOUR</td>
112
+ <td>=</td>
113
+ <td class='context-item-value'>60 * MILLISECONDS_IN_MINUTE</td>
114
+ </tr>
115
+ <tr class='top-aligned-row context-row'>
116
+ <td class='context-item-name'>MILLISECONDS_IN_DAY</td>
117
+ <td>=</td>
118
+ <td class='context-item-value'>24 * MILLISECONDS_IN_HOUR</td>
119
+ </tr>
120
+ </table>
121
+ </div>
122
+ </div>
123
+ <div id='methods'>
124
+ <h2>Public class methods</h2>
125
+ <div class='method public-class' id='method-M000055'>
126
+ <a name='M000055'></a>
127
+ <div class='synopsis'>
128
+ <span class='name'>new</span>
129
+ <span class='arguments'>(*args)</span>
130
+ </div>
131
+ <div class='description'>
132
+ <p>
133
+ Create an <a href="SdlTimeSpan.html">SdlTimeSpan</a>. Note: if the timespan
134
+ is negative all components should be negative.
135
+ </p>
136
+ <pre>SdlTimeSpan.new(days, hours, minutes, seconds = 0, milliseconds = 0)</pre>
137
+ <p>
138
+ or
139
+ </p>
140
+ <pre>SdlTimeSpan.new(totalMilliseconds)</pre>
141
+ </div>
142
+ <div class='source'>
143
+ <a class='source-toggle' href='#' onclick="toggleCode('M000055-source'); return false">
144
+ [show source]
145
+ </a>
146
+ <pre id='M000055-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 76</span>&#x000A;76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;77: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>&#x000A;78: <span class="ruby-identifier">initialize_total_milliseconds</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])&#x000A;79: <span class="ruby-keyword kw">else</span>&#x000A;80: <span class="ruby-identifier">initialize_days_hours_minutes</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;81: <span class="ruby-keyword kw">end</span>&#x000A;82: <span class="ruby-keyword kw">end</span></pre>
147
+ </div>
148
+ </div>
149
+ <h2>Public instance methods</h2>
150
+ <div class='method public-instance' id='method-M000081'>
151
+ <a name='M000081'></a>
152
+ <div class='synopsis'>
153
+ <span class='name'>&lt;=&gt;</span>
154
+ <span class='arguments'>(other)</span>
155
+ </div>
156
+ <div class='source'>
157
+ <a class='source-toggle' href='#' onclick="toggleCode('M000081-source'); return false">
158
+ [show source]
159
+ </a>
160
+ <pre id='M000081-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 233</span>&#x000A;233: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)&#x000A;234: <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">total_milliseconds</span>&#x000A;235: <span class="ruby-keyword kw">end</span></pre>
161
+ </div>
162
+ </div>
163
+ <div class='method public-instance' id='method-M000080'>
164
+ <a name='M000080'></a>
165
+ <div class='synopsis'>
166
+ <span class='name'>==</span>
167
+ <span class='arguments'>(other)</span>
168
+ </div>
169
+ <div class='description'>
170
+ <p>
171
+ Alias for <a href="SdlTimeSpan.html#M000079">eql?</a>
172
+ </p>
173
+ </div>
174
+ </div>
175
+ <div class='method public-instance' id='method-M000058'>
176
+ <a name='M000058'></a>
177
+ <div class='synopsis'>
178
+ <span class='name'>day</span>
179
+ <span class='arguments'>()</span>
180
+ </div>
181
+ <div class='description'>
182
+ <p>
183
+ Alias for <a href="SdlTimeSpan.html#M000057">days</a>
184
+ </p>
185
+ </div>
186
+ </div>
187
+ <div class='method public-instance' id='method-M000057'>
188
+ <a name='M000057'></a>
189
+ <div class='synopsis'>
190
+ <span class='name'>days</span>
191
+ <span class='arguments'>()</span>
192
+ </div>
193
+ <div class='description'>
194
+ <p>
195
+ The days component.
196
+ </p>
197
+ </div>
198
+ <div class='source'>
199
+ <a class='source-toggle' href='#' onclick="toggleCode('M000057-source'); return false">
200
+ [show source]
201
+ </a>
202
+ <pre id='M000057-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 92</span>&#x000A;92: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">days</span>&#x000A;93: <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span> (<span class="ruby-ivar">@totalMilliseconds</span>.<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>)&#x000A;94: <span class="ruby-keyword kw">end</span></pre>
203
+ </div>
204
+ </div>
205
+ <div class='method public-instance' id='method-M000079'>
206
+ <a name='M000079'></a>
207
+ <div class='synopsis'>
208
+ <span class='name'>eql?</span>
209
+ <span class='arguments'>(other)</span>
210
+ </div>
211
+ <div class='description'>
212
+ <p>
213
+ Tests for equivalence.
214
+ </p>
215
+ </div>
216
+ <div class='source'>
217
+ <a class='source-toggle' href='#' onclick="toggleCode('M000079-source'); return false">
218
+ [show source]
219
+ </a>
220
+ <pre id='M000079-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 226</span>&#x000A;226: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">other</span>)&#x000A;227: <span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">SdlTimeSpan</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">total_milliseconds</span>&#x000A;228: <span class="ruby-keyword kw">end</span></pre>
221
+ </div>
222
+ </div>
223
+ <div class='method public-instance' id='method-M000078'>
224
+ <a name='M000078'></a>
225
+ <div class='synopsis'>
226
+ <span class='name'>hash</span>
227
+ <span class='arguments'>()</span>
228
+ </div>
229
+ <div class='description'>
230
+ <p>
231
+ A hashcode based on the canonical string representation.
232
+ </p>
233
+ </div>
234
+ <div class='source'>
235
+ <a class='source-toggle' href='#' onclick="toggleCode('M000078-source'); return false">
236
+ [show source]
237
+ </a>
238
+ <pre id='M000078-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 220</span>&#x000A;220: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash</span>&#x000A;221: <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">hash</span>&#x000A;222: <span class="ruby-keyword kw">end</span></pre>
239
+ </div>
240
+ </div>
241
+ <div class='method public-instance' id='method-M000060'>
242
+ <a name='M000060'></a>
243
+ <div class='synopsis'>
244
+ <span class='name'>hour</span>
245
+ <span class='arguments'>()</span>
246
+ </div>
247
+ <div class='description'>
248
+ <p>
249
+ Alias for <a href="SdlTimeSpan.html#M000059">hours</a>
250
+ </p>
251
+ </div>
252
+ </div>
253
+ <div class='method public-instance' id='method-M000059'>
254
+ <a name='M000059'></a>
255
+ <div class='synopsis'>
256
+ <span class='name'>hours</span>
257
+ <span class='arguments'>()</span>
258
+ </div>
259
+ <div class='description'>
260
+ <p>
261
+ The hours component.
262
+ </p>
263
+ </div>
264
+ <div class='source'>
265
+ <a class='source-toggle' href='#' onclick="toggleCode('M000059-source'); return false">
266
+ [show source]
267
+ </a>
268
+ <pre id='M000059-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 99</span>&#x000A; 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hours</span>&#x000A;100: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span> ((<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>)).<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>)&#x000A;101: <span class="ruby-keyword kw">end</span></pre>
269
+ </div>
270
+ </div>
271
+ <div class='method public-instance' id='method-M000065'>
272
+ <a name='M000065'></a>
273
+ <div class='synopsis'>
274
+ <span class='name'>milliseconds</span>
275
+ <span class='arguments'>()</span>
276
+ </div>
277
+ <div class='description'>
278
+ <p>
279
+ The milliseconds component.
280
+ </p>
281
+ </div>
282
+ <div class='source'>
283
+ <a class='source-toggle' href='#' onclick="toggleCode('M000065-source'); return false">
284
+ [show source]
285
+ </a>
286
+ <pre id='M000065-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 125</span>&#x000A;125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">milliseconds</span>&#x000A;126: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span>&#x000A;127: (<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>) <span class="ruby-operator">-</span>&#x000A;128: (<span class="ruby-identifier">hours</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>) <span class="ruby-operator">-</span>&#x000A;129: (<span class="ruby-identifier">minutes</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>) <span class="ruby-operator">-</span>&#x000A;130: (<span class="ruby-identifier">seconds</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)&#x000A;131: <span class="ruby-keyword kw">end</span></pre>
287
+ </div>
288
+ </div>
289
+ <div class='method public-instance' id='method-M000062'>
290
+ <a name='M000062'></a>
291
+ <div class='synopsis'>
292
+ <span class='name'>min</span>
293
+ <span class='arguments'>()</span>
294
+ </div>
295
+ <div class='description'>
296
+ <p>
297
+ Alias for <a href="SdlTimeSpan.html#M000061">minutes</a>
298
+ </p>
299
+ </div>
300
+ </div>
301
+ <div class='method public-instance' id='method-M000061'>
302
+ <a name='M000061'></a>
303
+ <div class='synopsis'>
304
+ <span class='name'>minutes</span>
305
+ <span class='arguments'>()</span>
306
+ </div>
307
+ <div class='description'>
308
+ <p>
309
+ The minutes component.
310
+ </p>
311
+ </div>
312
+ <div class='source'>
313
+ <a class='source-toggle' href='#' onclick="toggleCode('M000061-source'); return false">
314
+ [show source]
315
+ </a>
316
+ <pre id='M000061-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 106</span>&#x000A;106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">minutes</span>&#x000A;107: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>&#x000A;108: ((<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>) <span class="ruby-operator">-</span> (<span class="ruby-identifier">hours</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>)).<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span>&#x000A;109: <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>)&#x000A;110: <span class="ruby-keyword kw">end</span></pre>
317
+ </div>
318
+ </div>
319
+ <div class='method public-instance' id='method-M000066'>
320
+ <a name='M000066'></a>
321
+ <div class='synopsis'>
322
+ <span class='name'>msec</span>
323
+ <span class='arguments'>()</span>
324
+ </div>
325
+ <div class='description'>
326
+ <p>
327
+ Alias for <a href="SdlTimeSpan.html#M000065">milliseconds</a>
328
+ </p>
329
+ </div>
330
+ </div>
331
+ <div class='method public-instance' id='method-M000072'>
332
+ <a name='M000072'></a>
333
+ <div class='synopsis'>
334
+ <span class='name'>negate</span>
335
+ <span class='arguments'>()</span>
336
+ </div>
337
+ <div class='description'>
338
+ <p>
339
+ Returns an new <a href="SdlTimeSpan.html">SdlTimeSpan</a> instance that is
340
+ the opposite of this instance
341
+ </p>
342
+ </div>
343
+ <div class='source'>
344
+ <a class='source-toggle' href='#' onclick="toggleCode('M000072-source'); return false">
345
+ [show source]
346
+ </a>
347
+ <pre id='M000072-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 169</span>&#x000A;169: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">negate</span>&#x000A;170: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">-</span><span class="ruby-ivar">@totalMilliseconds</span>)&#x000A;171: <span class="ruby-keyword kw">end</span></pre>
348
+ </div>
349
+ </div>
350
+ <div class='method public-instance' id='method-M000073'>
351
+ <a name='M000073'></a>
352
+ <div class='synopsis'>
353
+ <span class='name'>roll_days</span>
354
+ <span class='arguments'>(days)</span>
355
+ </div>
356
+ <div class='description'>
357
+ <p>
358
+ Return a new instance with the days adjusted by the given amount. Positive
359
+ numbers add days. Negative numbers remove days.
360
+ </p>
361
+ <table>
362
+ <tr><td valign="top"><tt>days</tt>:</td><td>The adjustment (days to add or subtract)
363
+
364
+ </td></tr>
365
+ </table>
366
+ </div>
367
+ <div class='source'>
368
+ <a class='source-toggle' href='#' onclick="toggleCode('M000073-source'); return false">
369
+ [show source]
370
+ </a>
371
+ <pre id='M000073-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 178</span>&#x000A;178: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_days</span>(<span class="ruby-identifier">days</span>)&#x000A;179: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>))&#x000A;180: <span class="ruby-keyword kw">end</span></pre>
372
+ </div>
373
+ </div>
374
+ <div class='method public-instance' id='method-M000074'>
375
+ <a name='M000074'></a>
376
+ <div class='synopsis'>
377
+ <span class='name'>roll_hours</span>
378
+ <span class='arguments'>(hours)</span>
379
+ </div>
380
+ <div class='description'>
381
+ <p>
382
+ Return a new instance with the hours adjusted by the given amount. Positive
383
+ numbers add hours. Negative numbers remove hours.
384
+ </p>
385
+ <table>
386
+ <tr><td valign="top"><tt>hours</tt>:</td><td>The adjustment (hours to add or subtract)
387
+
388
+ </td></tr>
389
+ </table>
390
+ </div>
391
+ <div class='source'>
392
+ <a class='source-toggle' href='#' onclick="toggleCode('M000074-source'); return false">
393
+ [show source]
394
+ </a>
395
+ <pre id='M000074-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 187</span>&#x000A;187: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_hours</span>(<span class="ruby-identifier">hours</span>)&#x000A;188: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">hours</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>))&#x000A;189: <span class="ruby-keyword kw">end</span></pre>
396
+ </div>
397
+ </div>
398
+ <div class='method public-instance' id='method-M000077'>
399
+ <a name='M000077'></a>
400
+ <div class='synopsis'>
401
+ <span class='name'>roll_milliseconds</span>
402
+ <span class='arguments'>(milliseconds)</span>
403
+ </div>
404
+ <div class='description'>
405
+ <p>
406
+ Return a new instance with the milliseconds adjusted by the given amount.
407
+ Positive numbers add milliseconds. Negative numbers remove milliseconds.
408
+ </p>
409
+ <table>
410
+ <tr><td valign="top"><tt>milliseconds</tt>:</td><td>The adjustment (milliseconds to add or subtract)
411
+
412
+ </td></tr>
413
+ </table>
414
+ </div>
415
+ <div class='source'>
416
+ <a class='source-toggle' href='#' onclick="toggleCode('M000077-source'); return false">
417
+ [show source]
418
+ </a>
419
+ <pre id='M000077-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 214</span>&#x000A;214: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_milliseconds</span>(<span class="ruby-identifier">milliseconds</span>)&#x000A;215: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">milliseconds</span>)&#x000A;216: <span class="ruby-keyword kw">end</span></pre>
420
+ </div>
421
+ </div>
422
+ <div class='method public-instance' id='method-M000075'>
423
+ <a name='M000075'></a>
424
+ <div class='synopsis'>
425
+ <span class='name'>roll_minutes</span>
426
+ <span class='arguments'>(minutes)</span>
427
+ </div>
428
+ <div class='description'>
429
+ <p>
430
+ Return a new instance with the minutes adjusted by the given amount.
431
+ Positive numbers add minutes. Negative numbers remove minutes.
432
+ </p>
433
+ <table>
434
+ <tr><td valign="top"><tt>minutes</tt>:</td><td>The adjustment (minutes to add or subtract)
435
+
436
+ </td></tr>
437
+ </table>
438
+ </div>
439
+ <div class='source'>
440
+ <a class='source-toggle' href='#' onclick="toggleCode('M000075-source'); return false">
441
+ [show source]
442
+ </a>
443
+ <pre id='M000075-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 196</span>&#x000A;196: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_minutes</span>(<span class="ruby-identifier">minutes</span>)&#x000A;197: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">minutes</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>))&#x000A;198: <span class="ruby-keyword kw">end</span></pre>
444
+ </div>
445
+ </div>
446
+ <div class='method public-instance' id='method-M000076'>
447
+ <a name='M000076'></a>
448
+ <div class='synopsis'>
449
+ <span class='name'>roll_seconds</span>
450
+ <span class='arguments'>(seconds)</span>
451
+ </div>
452
+ <div class='description'>
453
+ <p>
454
+ Return a new instance with the seconds adjusted by the given amount.
455
+ Positive numbers add seconds. Negative numbers remove seconds.
456
+ </p>
457
+ <table>
458
+ <tr><td valign="top"><tt>seconds</tt>:</td><td>The adjustment (seconds to add or subtract)
459
+
460
+ </td></tr>
461
+ </table>
462
+ </div>
463
+ <div class='source'>
464
+ <a class='source-toggle' href='#' onclick="toggleCode('M000076-source'); return false">
465
+ [show source]
466
+ </a>
467
+ <pre id='M000076-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 205</span>&#x000A;205: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_seconds</span>(<span class="ruby-identifier">seconds</span>)&#x000A;206: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">seconds</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>))&#x000A;207: <span class="ruby-keyword kw">end</span></pre>
468
+ </div>
469
+ </div>
470
+ <div class='method public-instance' id='method-M000064'>
471
+ <a name='M000064'></a>
472
+ <div class='synopsis'>
473
+ <span class='name'>sec</span>
474
+ <span class='arguments'>()</span>
475
+ </div>
476
+ <div class='description'>
477
+ <p>
478
+ Alias for <a href="SdlTimeSpan.html#M000063">seconds</a>
479
+ </p>
480
+ </div>
481
+ </div>
482
+ <div class='method public-instance' id='method-M000063'>
483
+ <a name='M000063'></a>
484
+ <div class='synopsis'>
485
+ <span class='name'>seconds</span>
486
+ <span class='arguments'>()</span>
487
+ </div>
488
+ <div class='description'>
489
+ <p>
490
+ The seconds component.
491
+ </p>
492
+ </div>
493
+ <div class='source'>
494
+ <a class='source-toggle' href='#' onclick="toggleCode('M000063-source'); return false">
495
+ [show source]
496
+ </a>
497
+ <pre id='M000063-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 115</span>&#x000A;115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">seconds</span>&#x000A;116: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>&#x000A;117: ((<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>) <span class="ruby-operator">-</span> (<span class="ruby-identifier">hours</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>) <span class="ruby-operator">-</span>&#x000A;118: (<span class="ruby-identifier">minutes</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>)).<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span>&#x000A;119: <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)&#x000A;120: <span class="ruby-keyword kw">end</span></pre>
498
+ </div>
499
+ </div>
500
+ <div class='method public-instance' id='method-M000056'>
501
+ <a name='M000056'></a>
502
+ <div class='synopsis'>
503
+ <span class='name'>sign</span>
504
+ <span class='arguments'>()</span>
505
+ </div>
506
+ <div class='description'>
507
+ <p>
508
+ Returns the sign (-1 or +1) of this <a
509
+ href="SdlTimeSpan.html">SdlTimeSpan</a>.
510
+ </p>
511
+ </div>
512
+ <div class='source'>
513
+ <a class='source-toggle' href='#' onclick="toggleCode('M000056-source'); return false">
514
+ [show source]
515
+ </a>
516
+ <pre id='M000056-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 86</span>&#x000A;86: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sign</span>&#x000A;87: <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-value">0</span>&#x000A;88: <span class="ruby-keyword kw">end</span></pre>
517
+ </div>
518
+ </div>
519
+ <div class='method public-instance' id='method-M000082'>
520
+ <a name='M000082'></a>
521
+ <div class='synopsis'>
522
+ <span class='name'>to_s</span>
523
+ <span class='arguments'>(force_show_days = false)</span>
524
+ </div>
525
+ <div class='description'>
526
+ <p>
527
+ Returns an SDL representation of this time span using the format:
528
+ </p>
529
+ <pre>(days:)hours:minutes:seconds(.milliseconds)</pre>
530
+ <p>
531
+ (parenthesis indicate optional components)
532
+ </p>
533
+ <p>
534
+ The days and milliseconds components will not be included if they are set
535
+ to 0. Days must be suffixed with &#8220;d&#8221; for clarity.
536
+ </p>
537
+ <p>
538
+ Hours, minutes, and seconds will be zero paded to two characters.
539
+ </p>
540
+ <p>
541
+ Examples:
542
+ </p>
543
+ <pre>23:13:00 (12 hours and 13 minutes)&#x000A;24d:12:13:09.234 (24 days, 12 hours, 13 minutes, 9 seconds,&#x000A; 234 milliseconds)</pre>
544
+ </div>
545
+ <div class='source'>
546
+ <a class='source-toggle' href='#' onclick="toggleCode('M000082-source'); return false">
547
+ [show source]
548
+ </a>
549
+ <pre id='M000082-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 254</span>&#x000A;254: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>(<span class="ruby-identifier">force_show_days</span> = <span class="ruby-keyword kw">false</span>)&#x000A;255: <span class="ruby-identifier">_days</span> = <span class="ruby-identifier">days</span>&#x000A;256: <span class="ruby-identifier">_milliseconds</span> = <span class="ruby-identifier">milliseconds</span>&#x000A;257: &#x000A;258: <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">nil</span>&#x000A;259: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_days</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">force_show_days</span>&#x000A;260: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>&#x000A;261: <span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">&quot;%d:%02d:%02d&quot;</span>, <span class="ruby-identifier">hours</span>, <span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>, <span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>)&#x000A;262: <span class="ruby-keyword kw">else</span>&#x000A;263: <span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">&quot;%d:%02d:%02d.%03d&quot;</span>, <span class="ruby-identifier">hours</span>, <span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>, <span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>, <span class="ruby-identifier">_milliseconds</span>.<span class="ruby-identifier">abs</span>)&#x000A;264: <span class="ruby-keyword kw">end</span>&#x000A;265: <span class="ruby-keyword kw">else</span>&#x000A;266: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>&#x000A;267: <span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">&quot;%dd:%02d:%02d:%02d&quot;</span>, <span class="ruby-identifier">_days</span>, <span class="ruby-identifier">hours</span>.<span class="ruby-identifier">abs</span>, <span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>, <span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>)&#x000A;268: <span class="ruby-keyword kw">else</span>&#x000A;269: <span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(&#x000A;270: <span class="ruby-value str">&quot;%dd:%02d:%02d:%02d.%03d&quot;</span>,&#x000A;271: <span class="ruby-identifier">_days</span>,&#x000A;272: <span class="ruby-identifier">hours</span>.<span class="ruby-identifier">abs</span>,&#x000A;273: <span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>,&#x000A;274: <span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>,&#x000A;275: <span class="ruby-identifier">_milliseconds</span>.<span class="ruby-identifier">abs</span>)&#x000A;276: <span class="ruby-keyword kw">end</span>&#x000A;277: <span class="ruby-keyword kw">end</span>&#x000A;278: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">s</span>&#x000A;279: <span class="ruby-keyword kw">end</span></pre>
550
+ </div>
551
+ </div>
552
+ <div class='method public-instance' id='method-M000068'>
553
+ <a name='M000068'></a>
554
+ <div class='synopsis'>
555
+ <span class='name'>total_hours</span>
556
+ <span class='arguments'>()</span>
557
+ </div>
558
+ <div class='description'>
559
+ <p>
560
+ Get the total number of hours in this time span. For example, if this time
561
+ span represents two days, this method will return 48.
562
+ </p>
563
+ </div>
564
+ <div class='source'>
565
+ <a class='source-toggle' href='#' onclick="toggleCode('M000068-source'); return false">
566
+ [show source]
567
+ </a>
568
+ <pre id='M000068-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 141</span>&#x000A;141: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_hours</span>&#x000A;142: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span> (<span class="ruby-ivar">@totalMilliseconds</span>.<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>)&#x000A;143: <span class="ruby-keyword kw">end</span></pre>
569
+ </div>
570
+ </div>
571
+ <div class='method public-instance' id='method-M000071'>
572
+ <a name='M000071'></a>
573
+ <div class='synopsis'>
574
+ <span class='name'>total_milliseconds</span>
575
+ <span class='arguments'>()</span>
576
+ </div>
577
+ <div class='description'>
578
+ <p>
579
+ Get the total number of milliseconds in this time span. For example, if
580
+ this time span represents 4 seconds, this method will return 4000.
581
+ </p>
582
+ </div>
583
+ <div class='source'>
584
+ <a class='source-toggle' href='#' onclick="toggleCode('M000071-source'); return false">
585
+ [show source]
586
+ </a>
587
+ <pre id='M000071-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 162</span>&#x000A;162: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_milliseconds</span>&#x000A;163: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span>&#x000A;164: <span class="ruby-keyword kw">end</span></pre>
588
+ </div>
589
+ </div>
590
+ <div class='method public-instance' id='method-M000069'>
591
+ <a name='M000069'></a>
592
+ <div class='synopsis'>
593
+ <span class='name'>total_minutes</span>
594
+ <span class='arguments'>()</span>
595
+ </div>
596
+ <div class='description'>
597
+ <p>
598
+ Get the total number of minutes in this time span. For example, if this
599
+ time span represents two hours, this method will return 120.
600
+ </p>
601
+ </div>
602
+ <div class='source'>
603
+ <a class='source-toggle' href='#' onclick="toggleCode('M000069-source'); return false">
604
+ [show source]
605
+ </a>
606
+ <pre id='M000069-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 148</span>&#x000A;148: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_minutes</span>&#x000A;149: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span> (<span class="ruby-ivar">@totalMilliseconds</span>.<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span> <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>)&#x000A;150: <span class="ruby-keyword kw">end</span></pre>
607
+ </div>
608
+ </div>
609
+ <div class='method public-instance' id='method-M000070'>
610
+ <a name='M000070'></a>
611
+ <div class='synopsis'>
612
+ <span class='name'>total_seconds</span>
613
+ <span class='arguments'>()</span>
614
+ </div>
615
+ <div class='description'>
616
+ <p>
617
+ Get the total number of seconds in this time span. For example, if this
618
+ time span represents three minutes, this method will return 180.
619
+ </p>
620
+ </div>
621
+ <div class='source'>
622
+ <a class='source-toggle' href='#' onclick="toggleCode('M000070-source'); return false">
623
+ [show source]
624
+ </a>
625
+ <pre id='M000070-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 155</span>&#x000A;155: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_seconds</span>&#x000A;156: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span> (<span class="ruby-ivar">@totalMilliseconds</span>.<span class="ruby-identifier">abs</span> <span class="ruby-operator">/</span> <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)&#x000A;157: <span class="ruby-keyword kw">end</span></pre>
626
+ </div>
627
+ </div>
628
+ <div class='method public-instance' id='method-M000067'>
629
+ <a name='M000067'></a>
630
+ <div class='synopsis'>
631
+ <span class='name'>usec</span>
632
+ <span class='arguments'>()</span>
633
+ </div>
634
+ <div class='source'>
635
+ <a class='source-toggle' href='#' onclick="toggleCode('M000067-source'); return false">
636
+ [show source]
637
+ </a>
638
+ <pre id='M000067-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 134</span>&#x000A;134: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">usec</span>&#x000A;135: <span class="ruby-identifier">milliseconds</span> <span class="ruby-operator">*</span> <span class="ruby-value">1000</span>&#x000A;136: <span class="ruby-keyword kw">end</span></pre>
639
+ </div>
640
+ </div>
641
+ </div>
642
+ </div>
643
+ </div>
644
+ </div>
645
+ <div id='footer-push'></div>
646
+ </div>
647
+ <div id='footer'>
648
+ <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
649
+ </div>
650
+ </body>
651
+ </html>