sdl4r 0.9.3 → 0.9.4
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.
- data/CHANGELOG +13 -0
- data/README +2 -2
- data/Rakefile +3 -3
- data/TODO.txt +28 -11
- data/doc/classes/SDL4R.html +681 -0
- data/doc/classes/SDL4R/Parser.html +314 -0
- data/doc/classes/SDL4R/SdlBinary.html +303 -0
- data/doc/classes/SDL4R/SdlParseError.html +185 -0
- data/doc/classes/SDL4R/SdlTimeSpan.html +948 -0
- data/doc/classes/SDL4R/Tag.html +2028 -0
- data/doc/created.rid +1 -1
- data/doc/files/CHANGELOG.html +130 -0
- data/doc/files/LICENSE.html +756 -0
- data/doc/files/README.html +606 -0
- data/doc/files/lib/sdl4r/parser/reader_rb.html +108 -0
- data/doc/files/lib/sdl4r/parser/time_span_with_zone_rb.html +101 -0
- data/doc/files/lib/sdl4r/parser/token_rb.html +101 -0
- data/doc/files/lib/sdl4r/parser/tokenizer_rb.html +101 -0
- data/doc/files/lib/sdl4r/parser_rb.html +108 -0
- data/doc/files/lib/sdl4r/sdl4r_rb.html +111 -0
- data/doc/files/lib/sdl4r/sdl_binary_rb.html +101 -0
- data/doc/files/lib/sdl4r/sdl_parse_error_rb.html +101 -0
- data/doc/files/lib/sdl4r/sdl_time_span_rb.html +101 -0
- data/doc/files/lib/sdl4r/tag_rb.html +110 -0
- data/doc/files/lib/sdl4r_rb.html +101 -0
- data/doc/fr_file_index.html +2 -1
- data/doc/fr_method_index.html +88 -82
- data/lib/sdl4r.rb +18 -0
- data/lib/sdl4r/parser.rb +2 -9
- data/lib/sdl4r/{sdl.rb → sdl4r.rb} +46 -7
- data/lib/sdl4r/sdl_time_span.rb +6 -1
- data/lib/sdl4r/tag.rb +6 -7
- data/test/sdl4r/parser_test.rb +4 -16
- data/test/sdl4r/sdl4r_test.rb +3 -13
- data/test/sdl4r/sdl_test.rb +39 -0
- metadata +29 -6
@@ -0,0 +1,185 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: SDL4R::SdlParseError</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">SDL4R::SdlParseError</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../../files/lib/sdl4r/sdl_parse_error_rb.html">
|
59
|
+
lib/sdl4r/sdl_parse_error.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
<tr class="top-aligned-row">
|
66
|
+
<td><strong>Parent:</strong></td>
|
67
|
+
<td>
|
68
|
+
StandardError
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
<!-- banner header -->
|
74
|
+
|
75
|
+
<div id="bodyContent">
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<div id="contextContent">
|
80
|
+
|
81
|
+
<div id="description">
|
82
|
+
<p>
|
83
|
+
An exception describing a problem with an SDL document‘s structure
|
84
|
+
</p>
|
85
|
+
|
86
|
+
</div>
|
87
|
+
|
88
|
+
|
89
|
+
</div>
|
90
|
+
|
91
|
+
<div id="method-list">
|
92
|
+
<h3 class="section-bar">Methods</h3>
|
93
|
+
|
94
|
+
<div class="name-list">
|
95
|
+
<a href="#M000061">new</a>
|
96
|
+
</div>
|
97
|
+
</div>
|
98
|
+
|
99
|
+
</div>
|
100
|
+
|
101
|
+
|
102
|
+
<!-- if includes -->
|
103
|
+
|
104
|
+
<div id="section">
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
<div id="attribute-list">
|
111
|
+
<h3 class="section-bar">Attributes</h3>
|
112
|
+
|
113
|
+
<div class="name-list">
|
114
|
+
<table>
|
115
|
+
<tr class="top-aligned-row context-row">
|
116
|
+
<td class="context-item-name">line</td>
|
117
|
+
<td class="context-item-value"> [R] </td>
|
118
|
+
<td class="context-item-desc"></td>
|
119
|
+
</tr>
|
120
|
+
<tr class="top-aligned-row context-row">
|
121
|
+
<td class="context-item-name">position</td>
|
122
|
+
<td class="context-item-value"> [R] </td>
|
123
|
+
<td class="context-item-desc"></td>
|
124
|
+
</tr>
|
125
|
+
</table>
|
126
|
+
</div>
|
127
|
+
</div>
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
<!-- if method_list -->
|
132
|
+
<div id="methods">
|
133
|
+
<h3 class="section-bar">Public Class methods</h3>
|
134
|
+
|
135
|
+
<div id="method-M000061" class="method-detail">
|
136
|
+
<a name="M000061"></a>
|
137
|
+
|
138
|
+
<div class="method-heading">
|
139
|
+
<a href="#M000061" class="method-signature">
|
140
|
+
<span class="method-name">new</span><span class="method-args">(description, line_no, position, line = nil)</span>
|
141
|
+
</a>
|
142
|
+
</div>
|
143
|
+
|
144
|
+
<div class="method-description">
|
145
|
+
<p>
|
146
|
+
Note: Line and positioning numbering start with 1 rather than 0 to be
|
147
|
+
consistent with most editors.
|
148
|
+
</p>
|
149
|
+
<p>
|
150
|
+
<tt>description</tt> A description of the problem. <tt>lineNo</tt> The line
|
151
|
+
on which the error occured or -1 for unknown <tt>position</tt> The position
|
152
|
+
(within the line) where the error occured or -1 for unknown
|
153
|
+
</p>
|
154
|
+
<p><a class="source-toggle" href="#"
|
155
|
+
onclick="toggleCode('M000061-source');return false;">[Source]</a></p>
|
156
|
+
<div class="method-source-code" id="M000061-source">
|
157
|
+
<pre>
|
158
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_parse_error.rb, line 33</span>
|
159
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">description</span>, <span class="ruby-identifier">line_no</span>, <span class="ruby-identifier">position</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>)
|
160
|
+
<span class="ruby-keyword kw">super</span>(
|
161
|
+
<span class="ruby-node">"#{description} Line "</span> <span class="ruby-operator">+</span> ((<span class="ruby-identifier">line_no</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">line_no</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>)<span class="ruby-operator">?</span> <span class="ruby-value str">"unknown"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">line_no</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">+</span>
|
162
|
+
<span class="ruby-value str">", Position "</span> <span class="ruby-operator">+</span> ((<span class="ruby-identifier">position</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">position</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>)<span class="ruby-operator">?</span> <span class="ruby-value str">"unknown"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">position</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">"\n"</span> <span class="ruby-operator">+</span>
|
163
|
+
(<span class="ruby-identifier">line</span> <span class="ruby-value">? </span><span class="ruby-identifier">line</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">position</span> <span class="ruby-value">? </span><span class="ruby-value str">" "</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">position</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>) <span class="ruby-operator">:</span> <span class="ruby-value str">""</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">"^"</span> <span class="ruby-operator">:</span> <span class="ruby-value str">""</span>))
|
164
|
+
|
165
|
+
<span class="ruby-ivar">@lineNo</span> = <span class="ruby-identifier">line_no</span>
|
166
|
+
<span class="ruby-ivar">@position</span> = <span class="ruby-identifier">position</span>
|
167
|
+
<span class="ruby-keyword kw">end</span>
|
168
|
+
</pre>
|
169
|
+
</div>
|
170
|
+
</div>
|
171
|
+
</div>
|
172
|
+
|
173
|
+
|
174
|
+
</div>
|
175
|
+
|
176
|
+
|
177
|
+
</div>
|
178
|
+
|
179
|
+
|
180
|
+
<div id="validator-badges">
|
181
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
182
|
+
</div>
|
183
|
+
|
184
|
+
</body>
|
185
|
+
</html>
|
@@ -0,0 +1,948 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: SDL4R::SdlTimeSpan</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">SDL4R::SdlTimeSpan</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../../files/lib/sdl4r/sdl_time_span_rb.html">
|
59
|
+
lib/sdl4r/sdl_time_span.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
<tr class="top-aligned-row">
|
66
|
+
<td><strong>Parent:</strong></td>
|
67
|
+
<td>
|
68
|
+
Object
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
<!-- banner header -->
|
74
|
+
|
75
|
+
<div id="bodyContent">
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<div id="contextContent">
|
80
|
+
|
81
|
+
<div id="description">
|
82
|
+
<p>
|
83
|
+
Represents a period of time (duration) as opposed to a particular moment in
|
84
|
+
time (which would be represented using a Date, DateTime or Time instance).
|
85
|
+
</p>
|
86
|
+
|
87
|
+
</div>
|
88
|
+
|
89
|
+
|
90
|
+
</div>
|
91
|
+
|
92
|
+
<div id="method-list">
|
93
|
+
<h3 class="section-bar">Methods</h3>
|
94
|
+
|
95
|
+
<div class="name-list">
|
96
|
+
<a href="#M000087"><=></a>
|
97
|
+
<a href="#M000086">==</a>
|
98
|
+
<a href="#M000065">day</a>
|
99
|
+
<a href="#M000064">days</a>
|
100
|
+
<a href="#M000085">eql?</a>
|
101
|
+
<a href="#M000084">hash</a>
|
102
|
+
<a href="#M000067">hour</a>
|
103
|
+
<a href="#M000066">hours</a>
|
104
|
+
<a href="#M000072">milliseconds</a>
|
105
|
+
<a href="#M000069">min</a>
|
106
|
+
<a href="#M000068">minutes</a>
|
107
|
+
<a href="#M000078">negate</a>
|
108
|
+
<a href="#M000062">new</a>
|
109
|
+
<a href="#M000079">roll_days</a>
|
110
|
+
<a href="#M000080">roll_hours</a>
|
111
|
+
<a href="#M000083">roll_milliseconds</a>
|
112
|
+
<a href="#M000081">roll_minutes</a>
|
113
|
+
<a href="#M000082">roll_seconds</a>
|
114
|
+
<a href="#M000071">sec</a>
|
115
|
+
<a href="#M000070">seconds</a>
|
116
|
+
<a href="#M000063">sign</a>
|
117
|
+
<a href="#M000088">to_s</a>
|
118
|
+
<a href="#M000074">total_hours</a>
|
119
|
+
<a href="#M000077">total_milliseconds</a>
|
120
|
+
<a href="#M000075">total_minutes</a>
|
121
|
+
<a href="#M000076">total_seconds</a>
|
122
|
+
<a href="#M000073">usec</a>
|
123
|
+
</div>
|
124
|
+
</div>
|
125
|
+
|
126
|
+
</div>
|
127
|
+
|
128
|
+
|
129
|
+
<!-- if includes -->
|
130
|
+
<div id="includes">
|
131
|
+
<h3 class="section-bar">Included Modules</h3>
|
132
|
+
|
133
|
+
<div id="includes-list">
|
134
|
+
<span class="include-name">Comparable</span>
|
135
|
+
</div>
|
136
|
+
</div>
|
137
|
+
|
138
|
+
<div id="section">
|
139
|
+
|
140
|
+
|
141
|
+
<div id="constants-list">
|
142
|
+
<h3 class="section-bar">Constants</h3>
|
143
|
+
|
144
|
+
<div class="name-list">
|
145
|
+
<table summary="Constants">
|
146
|
+
<tr class="top-aligned-row context-row">
|
147
|
+
<td class="context-item-name">MILLISECONDS_IN_SECOND</td>
|
148
|
+
<td>=</td>
|
149
|
+
<td class="context-item-value">1000</td>
|
150
|
+
</tr>
|
151
|
+
<tr class="top-aligned-row context-row">
|
152
|
+
<td class="context-item-name">MILLISECONDS_IN_MINUTE</td>
|
153
|
+
<td>=</td>
|
154
|
+
<td class="context-item-value">60 * MILLISECONDS_IN_SECOND</td>
|
155
|
+
</tr>
|
156
|
+
<tr class="top-aligned-row context-row">
|
157
|
+
<td class="context-item-name">MILLISECONDS_IN_HOUR</td>
|
158
|
+
<td>=</td>
|
159
|
+
<td class="context-item-value">60 * MILLISECONDS_IN_MINUTE</td>
|
160
|
+
</tr>
|
161
|
+
<tr class="top-aligned-row context-row">
|
162
|
+
<td class="context-item-name">MILLISECONDS_IN_DAY</td>
|
163
|
+
<td>=</td>
|
164
|
+
<td class="context-item-value">24 * MILLISECONDS_IN_HOUR</td>
|
165
|
+
</tr>
|
166
|
+
</table>
|
167
|
+
</div>
|
168
|
+
</div>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<!-- if method_list -->
|
176
|
+
<div id="methods">
|
177
|
+
<h3 class="section-bar">Public Class methods</h3>
|
178
|
+
|
179
|
+
<div id="method-M000062" class="method-detail">
|
180
|
+
<a name="M000062"></a>
|
181
|
+
|
182
|
+
<div class="method-heading">
|
183
|
+
<a href="#M000062" class="method-signature">
|
184
|
+
<span class="method-name">new</span><span class="method-args">(*args)</span>
|
185
|
+
</a>
|
186
|
+
</div>
|
187
|
+
|
188
|
+
<div class="method-description">
|
189
|
+
<p>
|
190
|
+
Create an <a href="SdlTimeSpan.html">SdlTimeSpan</a>. Note: if the timespan
|
191
|
+
is negative all components should be negative.
|
192
|
+
</p>
|
193
|
+
<pre>
|
194
|
+
SdlTimeSpan.new(days, hours, minutes, seconds = 0, milliseconds = 0)
|
195
|
+
</pre>
|
196
|
+
<p>
|
197
|
+
or
|
198
|
+
</p>
|
199
|
+
<pre>
|
200
|
+
SdlTimeSpan.new(totalMilliseconds)
|
201
|
+
</pre>
|
202
|
+
<p><a class="source-toggle" href="#"
|
203
|
+
onclick="toggleCode('M000062-source');return false;">[Source]</a></p>
|
204
|
+
<div class="method-source-code" id="M000062-source">
|
205
|
+
<pre>
|
206
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 73</span>
|
207
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
208
|
+
<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>
|
209
|
+
<span class="ruby-identifier">initialize_total_milliseconds</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
|
210
|
+
<span class="ruby-keyword kw">else</span>
|
211
|
+
<span class="ruby-identifier">initialize_days_hours_minutes</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
212
|
+
<span class="ruby-keyword kw">end</span>
|
213
|
+
<span class="ruby-keyword kw">end</span>
|
214
|
+
</pre>
|
215
|
+
</div>
|
216
|
+
</div>
|
217
|
+
</div>
|
218
|
+
|
219
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
220
|
+
|
221
|
+
<div id="method-M000087" class="method-detail">
|
222
|
+
<a name="M000087"></a>
|
223
|
+
|
224
|
+
<div class="method-heading">
|
225
|
+
<a href="#M000087" class="method-signature">
|
226
|
+
<span class="method-name"><=></span><span class="method-args">(other)</span>
|
227
|
+
</a>
|
228
|
+
</div>
|
229
|
+
|
230
|
+
<div class="method-description">
|
231
|
+
<p><a class="source-toggle" href="#"
|
232
|
+
onclick="toggleCode('M000087-source');return false;">[Source]</a></p>
|
233
|
+
<div class="method-source-code" id="M000087-source">
|
234
|
+
<pre>
|
235
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 226</span>
|
236
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-operator"><=></span>(<span class="ruby-identifier">other</span>)
|
237
|
+
<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">total_milliseconds</span>
|
238
|
+
<span class="ruby-keyword kw">end</span>
|
239
|
+
</pre>
|
240
|
+
</div>
|
241
|
+
</div>
|
242
|
+
</div>
|
243
|
+
|
244
|
+
<div id="method-M000086" class="method-detail">
|
245
|
+
<a name="M000086"></a>
|
246
|
+
|
247
|
+
<div class="method-heading">
|
248
|
+
<span class="method-name">==</span><span class="method-args">(other)</span>
|
249
|
+
</div>
|
250
|
+
|
251
|
+
<div class="method-description">
|
252
|
+
<p>
|
253
|
+
Alias for eql?
|
254
|
+
</p>
|
255
|
+
</div>
|
256
|
+
</div>
|
257
|
+
|
258
|
+
<div id="method-M000065" class="method-detail">
|
259
|
+
<a name="M000065"></a>
|
260
|
+
|
261
|
+
<div class="method-heading">
|
262
|
+
<span class="method-name">day</span><span class="method-args">()</span>
|
263
|
+
</div>
|
264
|
+
|
265
|
+
<div class="method-description">
|
266
|
+
<p>
|
267
|
+
Alias for <a href="SdlTimeSpan.html#M000064">days</a>
|
268
|
+
</p>
|
269
|
+
</div>
|
270
|
+
</div>
|
271
|
+
|
272
|
+
<div id="method-M000064" class="method-detail">
|
273
|
+
<a name="M000064"></a>
|
274
|
+
|
275
|
+
<div class="method-heading">
|
276
|
+
<a href="#M000064" class="method-signature">
|
277
|
+
<span class="method-name">days</span><span class="method-args">()</span>
|
278
|
+
</a>
|
279
|
+
</div>
|
280
|
+
|
281
|
+
<div class="method-description">
|
282
|
+
<p>
|
283
|
+
The <a href="SdlTimeSpan.html#M000064">days</a> component.
|
284
|
+
</p>
|
285
|
+
<p><a class="source-toggle" href="#"
|
286
|
+
onclick="toggleCode('M000064-source');return false;">[Source]</a></p>
|
287
|
+
<div class="method-source-code" id="M000064-source">
|
288
|
+
<pre>
|
289
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 89</span>
|
290
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">days</span>
|
291
|
+
<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>)
|
292
|
+
<span class="ruby-keyword kw">end</span>
|
293
|
+
</pre>
|
294
|
+
</div>
|
295
|
+
</div>
|
296
|
+
</div>
|
297
|
+
|
298
|
+
<div id="method-M000085" class="method-detail">
|
299
|
+
<a name="M000085"></a>
|
300
|
+
|
301
|
+
<div class="method-heading">
|
302
|
+
<a href="#M000085" class="method-signature">
|
303
|
+
<span class="method-name">eql?</span><span class="method-args">(other)</span>
|
304
|
+
</a>
|
305
|
+
</div>
|
306
|
+
|
307
|
+
<div class="method-description">
|
308
|
+
<p>
|
309
|
+
Tests for equivalence.
|
310
|
+
</p>
|
311
|
+
<p><a class="source-toggle" href="#"
|
312
|
+
onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
|
313
|
+
<div class="method-source-code" id="M000085-source">
|
314
|
+
<pre>
|
315
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 219</span>
|
316
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">other</span>)
|
317
|
+
<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>
|
318
|
+
<span class="ruby-keyword kw">end</span>
|
319
|
+
</pre>
|
320
|
+
</div>
|
321
|
+
</div>
|
322
|
+
</div>
|
323
|
+
|
324
|
+
<div id="method-M000084" class="method-detail">
|
325
|
+
<a name="M000084"></a>
|
326
|
+
|
327
|
+
<div class="method-heading">
|
328
|
+
<a href="#M000084" class="method-signature">
|
329
|
+
<span class="method-name">hash</span><span class="method-args">()</span>
|
330
|
+
</a>
|
331
|
+
</div>
|
332
|
+
|
333
|
+
<div class="method-description">
|
334
|
+
<p>
|
335
|
+
A hashcode based on the canonical string representation.
|
336
|
+
</p>
|
337
|
+
<p><a class="source-toggle" href="#"
|
338
|
+
onclick="toggleCode('M000084-source');return false;">[Source]</a></p>
|
339
|
+
<div class="method-source-code" id="M000084-source">
|
340
|
+
<pre>
|
341
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 213</span>
|
342
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash</span>
|
343
|
+
<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">hash</span>
|
344
|
+
<span class="ruby-keyword kw">end</span>
|
345
|
+
</pre>
|
346
|
+
</div>
|
347
|
+
</div>
|
348
|
+
</div>
|
349
|
+
|
350
|
+
<div id="method-M000067" class="method-detail">
|
351
|
+
<a name="M000067"></a>
|
352
|
+
|
353
|
+
<div class="method-heading">
|
354
|
+
<span class="method-name">hour</span><span class="method-args">()</span>
|
355
|
+
</div>
|
356
|
+
|
357
|
+
<div class="method-description">
|
358
|
+
<p>
|
359
|
+
Alias for <a href="SdlTimeSpan.html#M000066">hours</a>
|
360
|
+
</p>
|
361
|
+
</div>
|
362
|
+
</div>
|
363
|
+
|
364
|
+
<div id="method-M000066" class="method-detail">
|
365
|
+
<a name="M000066"></a>
|
366
|
+
|
367
|
+
<div class="method-heading">
|
368
|
+
<a href="#M000066" class="method-signature">
|
369
|
+
<span class="method-name">hours</span><span class="method-args">()</span>
|
370
|
+
</a>
|
371
|
+
</div>
|
372
|
+
|
373
|
+
<div class="method-description">
|
374
|
+
<p>
|
375
|
+
The <a href="SdlTimeSpan.html#M000066">hours</a> component.
|
376
|
+
</p>
|
377
|
+
<p><a class="source-toggle" href="#"
|
378
|
+
onclick="toggleCode('M000066-source');return false;">[Source]</a></p>
|
379
|
+
<div class="method-source-code" id="M000066-source">
|
380
|
+
<pre>
|
381
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 96</span>
|
382
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hours</span>
|
383
|
+
<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>)
|
384
|
+
<span class="ruby-keyword kw">end</span>
|
385
|
+
</pre>
|
386
|
+
</div>
|
387
|
+
</div>
|
388
|
+
</div>
|
389
|
+
|
390
|
+
<div id="method-M000072" class="method-detail">
|
391
|
+
<a name="M000072"></a>
|
392
|
+
|
393
|
+
<div class="method-heading">
|
394
|
+
<a href="#M000072" class="method-signature">
|
395
|
+
<span class="method-name">milliseconds</span><span class="method-args">()</span>
|
396
|
+
</a>
|
397
|
+
</div>
|
398
|
+
|
399
|
+
<div class="method-description">
|
400
|
+
<p>
|
401
|
+
The <a href="SdlTimeSpan.html#M000072">milliseconds</a> component.
|
402
|
+
</p>
|
403
|
+
<p><a class="source-toggle" href="#"
|
404
|
+
onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
|
405
|
+
<div class="method-source-code" id="M000072-source">
|
406
|
+
<pre>
|
407
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 122</span>
|
408
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">milliseconds</span>
|
409
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span>
|
410
|
+
(<span class="ruby-identifier">days</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_DAY</span>) <span class="ruby-operator">-</span>
|
411
|
+
(<span class="ruby-identifier">hours</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_HOUR</span>) <span class="ruby-operator">-</span>
|
412
|
+
(<span class="ruby-identifier">minutes</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>) <span class="ruby-operator">-</span>
|
413
|
+
(<span class="ruby-identifier">seconds</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)
|
414
|
+
<span class="ruby-keyword kw">end</span>
|
415
|
+
</pre>
|
416
|
+
</div>
|
417
|
+
</div>
|
418
|
+
</div>
|
419
|
+
|
420
|
+
<div id="method-M000069" class="method-detail">
|
421
|
+
<a name="M000069"></a>
|
422
|
+
|
423
|
+
<div class="method-heading">
|
424
|
+
<span class="method-name">min</span><span class="method-args">()</span>
|
425
|
+
</div>
|
426
|
+
|
427
|
+
<div class="method-description">
|
428
|
+
<p>
|
429
|
+
Alias for <a href="SdlTimeSpan.html#M000068">minutes</a>
|
430
|
+
</p>
|
431
|
+
</div>
|
432
|
+
</div>
|
433
|
+
|
434
|
+
<div id="method-M000068" class="method-detail">
|
435
|
+
<a name="M000068"></a>
|
436
|
+
|
437
|
+
<div class="method-heading">
|
438
|
+
<a href="#M000068" class="method-signature">
|
439
|
+
<span class="method-name">minutes</span><span class="method-args">()</span>
|
440
|
+
</a>
|
441
|
+
</div>
|
442
|
+
|
443
|
+
<div class="method-description">
|
444
|
+
<p>
|
445
|
+
The <a href="SdlTimeSpan.html#M000068">minutes</a> component.
|
446
|
+
</p>
|
447
|
+
<p><a class="source-toggle" href="#"
|
448
|
+
onclick="toggleCode('M000068-source');return false;">[Source]</a></p>
|
449
|
+
<div class="method-source-code" id="M000068-source">
|
450
|
+
<pre>
|
451
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 103</span>
|
452
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">minutes</span>
|
453
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>
|
454
|
+
((<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>
|
455
|
+
<span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>)
|
456
|
+
<span class="ruby-keyword kw">end</span>
|
457
|
+
</pre>
|
458
|
+
</div>
|
459
|
+
</div>
|
460
|
+
</div>
|
461
|
+
|
462
|
+
<div id="method-M000078" class="method-detail">
|
463
|
+
<a name="M000078"></a>
|
464
|
+
|
465
|
+
<div class="method-heading">
|
466
|
+
<a href="#M000078" class="method-signature">
|
467
|
+
<span class="method-name">negate</span><span class="method-args">()</span>
|
468
|
+
</a>
|
469
|
+
</div>
|
470
|
+
|
471
|
+
<div class="method-description">
|
472
|
+
<p>
|
473
|
+
Returns an <a href="SdlTimeSpan.html#M000062">new</a> <a
|
474
|
+
href="SdlTimeSpan.html">SdlTimeSpan</a> instance that is the opposite of
|
475
|
+
this instance
|
476
|
+
</p>
|
477
|
+
<p><a class="source-toggle" href="#"
|
478
|
+
onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
|
479
|
+
<div class="method-source-code" id="M000078-source">
|
480
|
+
<pre>
|
481
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 162</span>
|
482
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">negate</span>
|
483
|
+
<span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">-</span><span class="ruby-ivar">@totalMilliseconds</span>)
|
484
|
+
<span class="ruby-keyword kw">end</span>
|
485
|
+
</pre>
|
486
|
+
</div>
|
487
|
+
</div>
|
488
|
+
</div>
|
489
|
+
|
490
|
+
<div id="method-M000079" class="method-detail">
|
491
|
+
<a name="M000079"></a>
|
492
|
+
|
493
|
+
<div class="method-heading">
|
494
|
+
<a href="#M000079" class="method-signature">
|
495
|
+
<span class="method-name">roll_days</span><span class="method-args">(days)</span>
|
496
|
+
</a>
|
497
|
+
</div>
|
498
|
+
|
499
|
+
<div class="method-description">
|
500
|
+
<p>
|
501
|
+
Return a <a href="SdlTimeSpan.html#M000062">new</a> instance with the <a
|
502
|
+
href="SdlTimeSpan.html#M000064">days</a> adjusted by the given amount.
|
503
|
+
Positive numbers add <a href="SdlTimeSpan.html#M000064">days</a>. Negative
|
504
|
+
numbers remove <a href="SdlTimeSpan.html#M000064">days</a>.
|
505
|
+
</p>
|
506
|
+
<table>
|
507
|
+
<tr><td valign="top"><tt><a href="SdlTimeSpan.html#M000064">days</a></tt>:</td><td>The adjustment (<a href="SdlTimeSpan.html#M000064">days</a> to add or
|
508
|
+
subtract)
|
509
|
+
|
510
|
+
</td></tr>
|
511
|
+
</table>
|
512
|
+
<p><a class="source-toggle" href="#"
|
513
|
+
onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
|
514
|
+
<div class="method-source-code" id="M000079-source">
|
515
|
+
<pre>
|
516
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 171</span>
|
517
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_days</span>(<span class="ruby-identifier">days</span>)
|
518
|
+
<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>))
|
519
|
+
<span class="ruby-keyword kw">end</span>
|
520
|
+
</pre>
|
521
|
+
</div>
|
522
|
+
</div>
|
523
|
+
</div>
|
524
|
+
|
525
|
+
<div id="method-M000080" class="method-detail">
|
526
|
+
<a name="M000080"></a>
|
527
|
+
|
528
|
+
<div class="method-heading">
|
529
|
+
<a href="#M000080" class="method-signature">
|
530
|
+
<span class="method-name">roll_hours</span><span class="method-args">(hours)</span>
|
531
|
+
</a>
|
532
|
+
</div>
|
533
|
+
|
534
|
+
<div class="method-description">
|
535
|
+
<p>
|
536
|
+
Return a <a href="SdlTimeSpan.html#M000062">new</a> instance with the <a
|
537
|
+
href="SdlTimeSpan.html#M000066">hours</a> adjusted by the given amount.
|
538
|
+
Positive numbers add <a href="SdlTimeSpan.html#M000066">hours</a>. Negative
|
539
|
+
numbers remove <a href="SdlTimeSpan.html#M000066">hours</a>.
|
540
|
+
</p>
|
541
|
+
<table>
|
542
|
+
<tr><td valign="top"><tt><a href="SdlTimeSpan.html#M000066">hours</a></tt>:</td><td>The adjustment (<a href="SdlTimeSpan.html#M000066">hours</a> to add or
|
543
|
+
subtract)
|
544
|
+
|
545
|
+
</td></tr>
|
546
|
+
</table>
|
547
|
+
<p><a class="source-toggle" href="#"
|
548
|
+
onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
|
549
|
+
<div class="method-source-code" id="M000080-source">
|
550
|
+
<pre>
|
551
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 180</span>
|
552
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_hours</span>(<span class="ruby-identifier">hours</span>)
|
553
|
+
<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>))
|
554
|
+
<span class="ruby-keyword kw">end</span>
|
555
|
+
</pre>
|
556
|
+
</div>
|
557
|
+
</div>
|
558
|
+
</div>
|
559
|
+
|
560
|
+
<div id="method-M000083" class="method-detail">
|
561
|
+
<a name="M000083"></a>
|
562
|
+
|
563
|
+
<div class="method-heading">
|
564
|
+
<a href="#M000083" class="method-signature">
|
565
|
+
<span class="method-name">roll_milliseconds</span><span class="method-args">(milliseconds)</span>
|
566
|
+
</a>
|
567
|
+
</div>
|
568
|
+
|
569
|
+
<div class="method-description">
|
570
|
+
<p>
|
571
|
+
Return a <a href="SdlTimeSpan.html#M000062">new</a> instance with the <a
|
572
|
+
href="SdlTimeSpan.html#M000072">milliseconds</a> adjusted by the given
|
573
|
+
amount. Positive numbers add <a
|
574
|
+
href="SdlTimeSpan.html#M000072">milliseconds</a>. Negative numbers remove
|
575
|
+
<a href="SdlTimeSpan.html#M000072">milliseconds</a>.
|
576
|
+
</p>
|
577
|
+
<table>
|
578
|
+
<tr><td valign="top"><tt><a href="SdlTimeSpan.html#M000072">milliseconds</a></tt>:</td><td>The adjustment (<a href="SdlTimeSpan.html#M000072">milliseconds</a> to add
|
579
|
+
or subtract)
|
580
|
+
|
581
|
+
</td></tr>
|
582
|
+
</table>
|
583
|
+
<p><a class="source-toggle" href="#"
|
584
|
+
onclick="toggleCode('M000083-source');return false;">[Source]</a></p>
|
585
|
+
<div class="method-source-code" id="M000083-source">
|
586
|
+
<pre>
|
587
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 207</span>
|
588
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_milliseconds</span>(<span class="ruby-identifier">milliseconds</span>)
|
589
|
+
<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>)
|
590
|
+
<span class="ruby-keyword kw">end</span>
|
591
|
+
</pre>
|
592
|
+
</div>
|
593
|
+
</div>
|
594
|
+
</div>
|
595
|
+
|
596
|
+
<div id="method-M000081" class="method-detail">
|
597
|
+
<a name="M000081"></a>
|
598
|
+
|
599
|
+
<div class="method-heading">
|
600
|
+
<a href="#M000081" class="method-signature">
|
601
|
+
<span class="method-name">roll_minutes</span><span class="method-args">(minutes)</span>
|
602
|
+
</a>
|
603
|
+
</div>
|
604
|
+
|
605
|
+
<div class="method-description">
|
606
|
+
<p>
|
607
|
+
Return a <a href="SdlTimeSpan.html#M000062">new</a> instance with the <a
|
608
|
+
href="SdlTimeSpan.html#M000068">minutes</a> adjusted by the given amount.
|
609
|
+
Positive numbers add <a href="SdlTimeSpan.html#M000068">minutes</a>.
|
610
|
+
Negative numbers remove <a href="SdlTimeSpan.html#M000068">minutes</a>.
|
611
|
+
</p>
|
612
|
+
<table>
|
613
|
+
<tr><td valign="top"><tt><a href="SdlTimeSpan.html#M000068">minutes</a></tt>:</td><td>The adjustment (<a href="SdlTimeSpan.html#M000068">minutes</a> to add or
|
614
|
+
subtract)
|
615
|
+
|
616
|
+
</td></tr>
|
617
|
+
</table>
|
618
|
+
<p><a class="source-toggle" href="#"
|
619
|
+
onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
|
620
|
+
<div class="method-source-code" id="M000081-source">
|
621
|
+
<pre>
|
622
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 189</span>
|
623
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_minutes</span>(<span class="ruby-identifier">minutes</span>)
|
624
|
+
<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>))
|
625
|
+
<span class="ruby-keyword kw">end</span>
|
626
|
+
</pre>
|
627
|
+
</div>
|
628
|
+
</div>
|
629
|
+
</div>
|
630
|
+
|
631
|
+
<div id="method-M000082" class="method-detail">
|
632
|
+
<a name="M000082"></a>
|
633
|
+
|
634
|
+
<div class="method-heading">
|
635
|
+
<a href="#M000082" class="method-signature">
|
636
|
+
<span class="method-name">roll_seconds</span><span class="method-args">(seconds)</span>
|
637
|
+
</a>
|
638
|
+
</div>
|
639
|
+
|
640
|
+
<div class="method-description">
|
641
|
+
<p>
|
642
|
+
Return a <a href="SdlTimeSpan.html#M000062">new</a> instance with the <a
|
643
|
+
href="SdlTimeSpan.html#M000070">seconds</a> adjusted by the given amount.
|
644
|
+
Positive numbers add <a href="SdlTimeSpan.html#M000070">seconds</a>.
|
645
|
+
Negative numbers remove <a href="SdlTimeSpan.html#M000070">seconds</a>.
|
646
|
+
</p>
|
647
|
+
<table>
|
648
|
+
<tr><td valign="top"><tt><a href="SdlTimeSpan.html#M000070">seconds</a></tt>:</td><td>The adjustment (<a href="SdlTimeSpan.html#M000070">seconds</a> to add or
|
649
|
+
subtract)
|
650
|
+
|
651
|
+
</td></tr>
|
652
|
+
</table>
|
653
|
+
<p><a class="source-toggle" href="#"
|
654
|
+
onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
|
655
|
+
<div class="method-source-code" id="M000082-source">
|
656
|
+
<pre>
|
657
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 198</span>
|
658
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_seconds</span>(<span class="ruby-identifier">seconds</span>)
|
659
|
+
<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>))
|
660
|
+
<span class="ruby-keyword kw">end</span>
|
661
|
+
</pre>
|
662
|
+
</div>
|
663
|
+
</div>
|
664
|
+
</div>
|
665
|
+
|
666
|
+
<div id="method-M000071" class="method-detail">
|
667
|
+
<a name="M000071"></a>
|
668
|
+
|
669
|
+
<div class="method-heading">
|
670
|
+
<span class="method-name">sec</span><span class="method-args">()</span>
|
671
|
+
</div>
|
672
|
+
|
673
|
+
<div class="method-description">
|
674
|
+
<p>
|
675
|
+
Alias for <a href="SdlTimeSpan.html#M000070">seconds</a>
|
676
|
+
</p>
|
677
|
+
</div>
|
678
|
+
</div>
|
679
|
+
|
680
|
+
<div id="method-M000070" class="method-detail">
|
681
|
+
<a name="M000070"></a>
|
682
|
+
|
683
|
+
<div class="method-heading">
|
684
|
+
<a href="#M000070" class="method-signature">
|
685
|
+
<span class="method-name">seconds</span><span class="method-args">()</span>
|
686
|
+
</a>
|
687
|
+
</div>
|
688
|
+
|
689
|
+
<div class="method-description">
|
690
|
+
<p>
|
691
|
+
The <a href="SdlTimeSpan.html#M000070">seconds</a> component.
|
692
|
+
</p>
|
693
|
+
<p><a class="source-toggle" href="#"
|
694
|
+
onclick="toggleCode('M000070-source');return false;">[Source]</a></p>
|
695
|
+
<div class="method-source-code" id="M000070-source">
|
696
|
+
<pre>
|
697
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 112</span>
|
698
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">seconds</span>
|
699
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>
|
700
|
+
((<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>
|
701
|
+
(<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>
|
702
|
+
<span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)
|
703
|
+
<span class="ruby-keyword kw">end</span>
|
704
|
+
</pre>
|
705
|
+
</div>
|
706
|
+
</div>
|
707
|
+
</div>
|
708
|
+
|
709
|
+
<div id="method-M000063" class="method-detail">
|
710
|
+
<a name="M000063"></a>
|
711
|
+
|
712
|
+
<div class="method-heading">
|
713
|
+
<a href="#M000063" class="method-signature">
|
714
|
+
<span class="method-name">sign</span><span class="method-args">()</span>
|
715
|
+
</a>
|
716
|
+
</div>
|
717
|
+
|
718
|
+
<div class="method-description">
|
719
|
+
<p>
|
720
|
+
Returns the <a href="SdlTimeSpan.html#M000063">sign</a> (-1 or +1) of this
|
721
|
+
<a href="SdlTimeSpan.html">SdlTimeSpan</a>.
|
722
|
+
</p>
|
723
|
+
<p><a class="source-toggle" href="#"
|
724
|
+
onclick="toggleCode('M000063-source');return false;">[Source]</a></p>
|
725
|
+
<div class="method-source-code" id="M000063-source">
|
726
|
+
<pre>
|
727
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 83</span>
|
728
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sign</span>
|
729
|
+
<span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator"><=></span> <span class="ruby-value">0</span>
|
730
|
+
<span class="ruby-keyword kw">end</span>
|
731
|
+
</pre>
|
732
|
+
</div>
|
733
|
+
</div>
|
734
|
+
</div>
|
735
|
+
|
736
|
+
<div id="method-M000088" class="method-detail">
|
737
|
+
<a name="M000088"></a>
|
738
|
+
|
739
|
+
<div class="method-heading">
|
740
|
+
<a href="#M000088" class="method-signature">
|
741
|
+
<span class="method-name">to_s</span><span class="method-args">()</span>
|
742
|
+
</a>
|
743
|
+
</div>
|
744
|
+
|
745
|
+
<div class="method-description">
|
746
|
+
<p>
|
747
|
+
Returns an SDL representation of this time span using the format:
|
748
|
+
</p>
|
749
|
+
<pre>
|
750
|
+
(days:)hours:minutes:seconds(.milliseconds)
|
751
|
+
</pre>
|
752
|
+
<p>
|
753
|
+
(parenthesis indicate optional components)
|
754
|
+
</p>
|
755
|
+
<p>
|
756
|
+
The <a href="SdlTimeSpan.html#M000064">days</a> and <a
|
757
|
+
href="SdlTimeSpan.html#M000072">milliseconds</a> components will not be
|
758
|
+
included if they are set to 0. Days must be suffixed with "d" for
|
759
|
+
clarity.
|
760
|
+
</p>
|
761
|
+
<p>
|
762
|
+
Hours, <a href="SdlTimeSpan.html#M000068">minutes</a>, and <a
|
763
|
+
href="SdlTimeSpan.html#M000070">seconds</a> will be zero paded to two
|
764
|
+
characters.
|
765
|
+
</p>
|
766
|
+
<p>
|
767
|
+
Examples:
|
768
|
+
</p>
|
769
|
+
<pre>
|
770
|
+
23:13:00 (12 hours and 13 minutes)
|
771
|
+
24d:12:13:09.234 (24 days, 12 hours, 13 minutes, 9 seconds,
|
772
|
+
234 milliseconds)
|
773
|
+
</pre>
|
774
|
+
<p><a class="source-toggle" href="#"
|
775
|
+
onclick="toggleCode('M000088-source');return false;">[Source]</a></p>
|
776
|
+
<div class="method-source-code" id="M000088-source">
|
777
|
+
<pre>
|
778
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 247</span>
|
779
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
|
780
|
+
<span class="ruby-identifier">_days</span> = <span class="ruby-identifier">days</span>
|
781
|
+
<span class="ruby-identifier">_milliseconds</span> = <span class="ruby-identifier">milliseconds</span>
|
782
|
+
|
783
|
+
<span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">nil</span>
|
784
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_days</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
785
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
786
|
+
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">"%d:%02d:%02d"</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>)
|
787
|
+
<span class="ruby-keyword kw">else</span>
|
788
|
+
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">"%d:%02d:%02d.%03d"</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>)
|
789
|
+
<span class="ruby-keyword kw">end</span>
|
790
|
+
<span class="ruby-keyword kw">else</span>
|
791
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
792
|
+
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">"%dd:%02d:%02d:%02d"</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>)
|
793
|
+
<span class="ruby-keyword kw">else</span>
|
794
|
+
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(
|
795
|
+
<span class="ruby-value str">"%dd:%02d:%02d:%02d.%03d"</span>,
|
796
|
+
<span class="ruby-identifier">_days</span>,
|
797
|
+
<span class="ruby-identifier">hours</span>.<span class="ruby-identifier">abs</span>,
|
798
|
+
<span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>,
|
799
|
+
<span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>,
|
800
|
+
<span class="ruby-identifier">_milliseconds</span>.<span class="ruby-identifier">abs</span>)
|
801
|
+
<span class="ruby-keyword kw">end</span>
|
802
|
+
<span class="ruby-keyword kw">end</span>
|
803
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">s</span>
|
804
|
+
<span class="ruby-keyword kw">end</span>
|
805
|
+
</pre>
|
806
|
+
</div>
|
807
|
+
</div>
|
808
|
+
</div>
|
809
|
+
|
810
|
+
<div id="method-M000074" class="method-detail">
|
811
|
+
<a name="M000074"></a>
|
812
|
+
|
813
|
+
<div class="method-heading">
|
814
|
+
<a href="#M000074" class="method-signature">
|
815
|
+
<span class="method-name">total_hours</span><span class="method-args">()</span>
|
816
|
+
</a>
|
817
|
+
</div>
|
818
|
+
|
819
|
+
<div class="method-description">
|
820
|
+
<p>
|
821
|
+
Get the total number of <a href="SdlTimeSpan.html#M000066">hours</a> in
|
822
|
+
this time span. For example, if this time span represents two <a
|
823
|
+
href="SdlTimeSpan.html#M000064">days</a>, this method will return 48.
|
824
|
+
</p>
|
825
|
+
<p><a class="source-toggle" href="#"
|
826
|
+
onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
|
827
|
+
<div class="method-source-code" id="M000074-source">
|
828
|
+
<pre>
|
829
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 134</span>
|
830
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_hours</span>
|
831
|
+
<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>)
|
832
|
+
<span class="ruby-keyword kw">end</span>
|
833
|
+
</pre>
|
834
|
+
</div>
|
835
|
+
</div>
|
836
|
+
</div>
|
837
|
+
|
838
|
+
<div id="method-M000077" class="method-detail">
|
839
|
+
<a name="M000077"></a>
|
840
|
+
|
841
|
+
<div class="method-heading">
|
842
|
+
<a href="#M000077" class="method-signature">
|
843
|
+
<span class="method-name">total_milliseconds</span><span class="method-args">()</span>
|
844
|
+
</a>
|
845
|
+
</div>
|
846
|
+
|
847
|
+
<div class="method-description">
|
848
|
+
<p>
|
849
|
+
Get the total number of <a href="SdlTimeSpan.html#M000072">milliseconds</a>
|
850
|
+
in this time span. For example, if this time span represents 4 <a
|
851
|
+
href="SdlTimeSpan.html#M000070">seconds</a>, this method will return 4000.
|
852
|
+
</p>
|
853
|
+
<p><a class="source-toggle" href="#"
|
854
|
+
onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
|
855
|
+
<div class="method-source-code" id="M000077-source">
|
856
|
+
<pre>
|
857
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 155</span>
|
858
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_milliseconds</span>
|
859
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span>
|
860
|
+
<span class="ruby-keyword kw">end</span>
|
861
|
+
</pre>
|
862
|
+
</div>
|
863
|
+
</div>
|
864
|
+
</div>
|
865
|
+
|
866
|
+
<div id="method-M000075" class="method-detail">
|
867
|
+
<a name="M000075"></a>
|
868
|
+
|
869
|
+
<div class="method-heading">
|
870
|
+
<a href="#M000075" class="method-signature">
|
871
|
+
<span class="method-name">total_minutes</span><span class="method-args">()</span>
|
872
|
+
</a>
|
873
|
+
</div>
|
874
|
+
|
875
|
+
<div class="method-description">
|
876
|
+
<p>
|
877
|
+
Get the total number of <a href="SdlTimeSpan.html#M000068">minutes</a> in
|
878
|
+
this time span. For example, if this time span represents two <a
|
879
|
+
href="SdlTimeSpan.html#M000066">hours</a>, this method will return 120.
|
880
|
+
</p>
|
881
|
+
<p><a class="source-toggle" href="#"
|
882
|
+
onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
|
883
|
+
<div class="method-source-code" id="M000075-source">
|
884
|
+
<pre>
|
885
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 141</span>
|
886
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_minutes</span>
|
887
|
+
<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>)
|
888
|
+
<span class="ruby-keyword kw">end</span>
|
889
|
+
</pre>
|
890
|
+
</div>
|
891
|
+
</div>
|
892
|
+
</div>
|
893
|
+
|
894
|
+
<div id="method-M000076" class="method-detail">
|
895
|
+
<a name="M000076"></a>
|
896
|
+
|
897
|
+
<div class="method-heading">
|
898
|
+
<a href="#M000076" class="method-signature">
|
899
|
+
<span class="method-name">total_seconds</span><span class="method-args">()</span>
|
900
|
+
</a>
|
901
|
+
</div>
|
902
|
+
|
903
|
+
<div class="method-description">
|
904
|
+
<p>
|
905
|
+
Get the total number of <a href="SdlTimeSpan.html#M000070">seconds</a> in
|
906
|
+
this time span. For example, if this time span represents three <a
|
907
|
+
href="SdlTimeSpan.html#M000068">minutes</a>, this method will return 180.
|
908
|
+
</p>
|
909
|
+
<p><a class="source-toggle" href="#"
|
910
|
+
onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
|
911
|
+
<div class="method-source-code" id="M000076-source">
|
912
|
+
<pre>
|
913
|
+
<span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 148</span>
|
914
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_seconds</span>
|
915
|
+
<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>)
|
916
|
+
<span class="ruby-keyword kw">end</span>
|
917
|
+
</pre>
|
918
|
+
</div>
|
919
|
+
</div>
|
920
|
+
</div>
|
921
|
+
|
922
|
+
<div id="method-M000073" class="method-detail">
|
923
|
+
<a name="M000073"></a>
|
924
|
+
|
925
|
+
<div class="method-heading">
|
926
|
+
<span class="method-name">usec</span><span class="method-args">()</span>
|
927
|
+
</div>
|
928
|
+
|
929
|
+
<div class="method-description">
|
930
|
+
<p>
|
931
|
+
Alias for <a href="SdlTimeSpan.html#M000072">milliseconds</a>
|
932
|
+
</p>
|
933
|
+
</div>
|
934
|
+
</div>
|
935
|
+
|
936
|
+
|
937
|
+
</div>
|
938
|
+
|
939
|
+
|
940
|
+
</div>
|
941
|
+
|
942
|
+
|
943
|
+
<div id="validator-badges">
|
944
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
945
|
+
</div>
|
946
|
+
|
947
|
+
</body>
|
948
|
+
</html>
|