sdl4r 0.9.6 → 0.9.7
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 +49 -2
- data/Rakefile +35 -5
- data/TODO +29 -3
- data/doc/classes/SDL4R.html +386 -674
- data/doc/classes/SDL4R/Parser.html +183 -307
- data/doc/classes/SDL4R/ParserTest.html +357 -0
- data/doc/classes/SDL4R/SDL4RTest.html +532 -0
- data/doc/classes/SDL4R/SDLTest.html +77 -0
- data/doc/classes/SDL4R/SdlBinary.html +180 -295
- data/doc/classes/SDL4R/SdlParseError.html +105 -180
- data/doc/classes/SDL4R/SdlTimeSpan.html +628 -939
- data/doc/classes/SDL4R/Tag.html +1236 -2036
- data/doc/classes/SDL4R/TagTest.html +292 -0
- data/doc/created.rid +1 -1
- data/doc/files/CHANGELOG.html +183 -184
- data/doc/files/LICENSE.html +496 -755
- data/doc/files/README.html +399 -623
- data/doc/files/lib/sdl4r/parser/reader_rb.html +53 -106
- data/doc/files/lib/sdl4r/parser/time_span_with_zone_rb.html +53 -106
- data/doc/files/lib/sdl4r/parser/token_rb.html +53 -106
- data/doc/files/lib/sdl4r/parser/tokenizer_rb.html +53 -106
- data/doc/files/lib/sdl4r/parser_rb.html +60 -112
- data/doc/files/lib/sdl4r/sdl4r_rb.html +62 -114
- data/doc/files/lib/sdl4r/sdl_binary_rb.html +53 -106
- data/doc/files/lib/sdl4r/sdl_parse_error_rb.html +53 -106
- data/doc/files/lib/sdl4r/sdl_time_span_rb.html +53 -106
- data/doc/files/lib/sdl4r/tag_rb.html +62 -114
- data/doc/files/lib/sdl4r_rb.html +53 -106
- data/doc/files/test/sdl4r/parser_test_rb.html +63 -0
- data/doc/files/test/sdl4r/sdl4r_test_rb.html +66 -0
- data/doc/files/test/sdl4r/sdl_test_rb.html +63 -0
- data/doc/files/test/sdl4r/tag_test_rb.html +63 -0
- data/doc/fr_class_index.html +19 -32
- data/doc/fr_file_index.html +37 -40
- data/doc/fr_method_index.html +4707 -114
- data/doc/index.html +14 -23
- data/doc/rdoc-style.css +323 -203
- data/lib/sdl4r/parser/reader.rb +26 -19
- data/lib/sdl4r/parser/token.rb +3 -3
- data/lib/sdl4r/parser/tokenizer.rb +93 -98
- data/lib/sdl4r/sdl_parse_error.rb +2 -2
- data/lib/sdl4r/tag.rb +127 -73
- data/test/sdl4r/parser_test.rb +109 -11
- data/test/sdl4r/tag_test.rb +73 -4
- metadata +15 -12
@@ -1,185 +1,110 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
<
|
7
|
-
<
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
// ]]>
|
42
|
-
</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>
|
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::SdlParseError [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::SdlParseError
|
31
|
+
</h1>
|
32
|
+
<ol class='paths'>
|
33
|
+
<li>
|
34
|
+
<a href="../../files/lib/sdl4r/sdl_parse_error_rb.html">lib/sdl4r/sdl_parse_error.rb</a>
|
35
|
+
</li>
|
36
|
+
</ol>
|
37
|
+
<div class='parent'>
|
38
|
+
Parent:
|
39
|
+
<strong>StandardError</strong>
|
142
40
|
</div>
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
</
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
<
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
41
|
+
</div>
|
42
|
+
<div id='content'>
|
43
|
+
<div id='text'>
|
44
|
+
<div id='description'>
|
45
|
+
<p>
|
46
|
+
An exception describing a problem with an SDL document’s structure
|
47
|
+
</p>
|
48
|
+
</div>
|
49
|
+
<div id='method-list'>
|
50
|
+
<h2>Methods</h2>
|
51
|
+
<h3>public class</h3>
|
52
|
+
<ol>
|
53
|
+
<li><a href="#M000037">new</a></li>
|
54
|
+
</ol>
|
55
|
+
</div>
|
56
|
+
<div id='section'>
|
57
|
+
<div id='attribute-list'>
|
58
|
+
<h2 class='section-bar'>Attributes</h2>
|
59
|
+
<div class='name-list'>
|
60
|
+
<table>
|
61
|
+
<tr class='top-aligned-row context-row'>
|
62
|
+
<td class='context-item-name'>line</td>
|
63
|
+
<td class='context-item-value'>[R]</td>
|
64
|
+
<td class='context-item-desc'></td>
|
65
|
+
</tr>
|
66
|
+
<tr class='top-aligned-row context-row'>
|
67
|
+
<td class='context-item-name'>position</td>
|
68
|
+
<td class='context-item-value'>[R]</td>
|
69
|
+
<td class='context-item-desc'></td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
</div>
|
74
|
+
<div id='methods'>
|
75
|
+
<h2>Public class methods</h2>
|
76
|
+
<div class='method public-class' id='method-M000037'>
|
77
|
+
<a name='M000037'></a>
|
78
|
+
<div class='synopsis'>
|
79
|
+
<span class='name'>new</span>
|
80
|
+
<span class='arguments'>(description, line_no, position, line = nil)</span>
|
81
|
+
</div>
|
82
|
+
<div class='description'>
|
83
|
+
<p>
|
84
|
+
Note: Line and positioning numbering start with 1 rather than 0 to be
|
85
|
+
consistent with most editors.
|
86
|
+
</p>
|
87
|
+
<p>
|
88
|
+
<tt>description</tt> A description of the problem. <tt>lineNo</tt> The line
|
89
|
+
on which the error occured or -1 for unknown <tt>position</tt> The position
|
90
|
+
(within the line) where the error occured or -1 for unknown
|
91
|
+
</p>
|
92
|
+
</div>
|
93
|
+
<div class='source'>
|
94
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000037-source'); return false">
|
95
|
+
[show source]
|
96
|
+
</a>
|
97
|
+
<pre id='M000037-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_parse_error.rb, line 36</span>
36: <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>)
37: <span class="ruby-keyword kw">super</span>(
38: <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>
39: <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-identifier">$/</span> <span class="ruby-operator">+</span>
40: (<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>))
41: 
42: <span class="ruby-ivar">@line</span> = <span class="ruby-identifier">line_no</span>
43: <span class="ruby-ivar">@position</span> = <span class="ruby-identifier">position</span>
44: <span class="ruby-keyword kw">end</span></pre>
|
98
|
+
</div>
|
99
|
+
</div>
|
100
|
+
</div>
|
169
101
|
</div>
|
170
102
|
</div>
|
171
103
|
</div>
|
172
|
-
|
173
|
-
|
104
|
+
<div id='footer-push'></div>
|
105
|
+
</div>
|
106
|
+
<div id='footer'>
|
107
|
+
<a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
|
174
108
|
</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>
|
109
|
+
</body>
|
110
|
+
</html>
|
@@ -1,948 +1,637 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
<
|
7
|
-
<
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
// ]]>
|
42
|
-
</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 76</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 229</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 92</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 222</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 216</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 99</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>
|
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>
|
387
40
|
</div>
|
388
41
|
</div>
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
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 125</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>
|
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>
|
416
49
|
</div>
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
</
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
</
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
<
|
451
|
-
|
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>
|
50
|
+
<div id='method-list'>
|
51
|
+
<h2>Methods</h2>
|
52
|
+
<h3>public class</h3>
|
53
|
+
<ol>
|
54
|
+
<li><a href="#M000010">new</a></li>
|
55
|
+
</ol>
|
56
|
+
<h3>public instance</h3>
|
57
|
+
<ol>
|
58
|
+
<li><a href="#M000035"><=></a></li>
|
59
|
+
<li><a href="#M000034">==</a></li>
|
60
|
+
<li><a href="#M000013">day</a></li>
|
61
|
+
<li><a href="#M000012">days</a></li>
|
62
|
+
<li><a href="#M000033">eql?</a></li>
|
63
|
+
<li><a href="#M000032">hash</a></li>
|
64
|
+
<li><a href="#M000015">hour</a></li>
|
65
|
+
<li><a href="#M000014">hours</a></li>
|
66
|
+
<li><a href="#M000020">milliseconds</a></li>
|
67
|
+
<li><a href="#M000017">min</a></li>
|
68
|
+
<li><a href="#M000016">minutes</a></li>
|
69
|
+
<li><a href="#M000026">negate</a></li>
|
70
|
+
<li><a href="#M000027">roll_days</a></li>
|
71
|
+
<li><a href="#M000028">roll_hours</a></li>
|
72
|
+
<li><a href="#M000031">roll_milliseconds</a></li>
|
73
|
+
<li><a href="#M000029">roll_minutes</a></li>
|
74
|
+
<li><a href="#M000030">roll_seconds</a></li>
|
75
|
+
<li><a href="#M000019">sec</a></li>
|
76
|
+
<li><a href="#M000018">seconds</a></li>
|
77
|
+
<li><a href="#M000011">sign</a></li>
|
78
|
+
<li><a href="#M000036">to_s</a></li>
|
79
|
+
<li><a href="#M000022">total_hours</a></li>
|
80
|
+
<li><a href="#M000025">total_milliseconds</a></li>
|
81
|
+
<li><a href="#M000023">total_minutes</a></li>
|
82
|
+
<li><a href="#M000024">total_seconds</a></li>
|
83
|
+
<li><a href="#M000021">usec</a></li>
|
84
|
+
</ol>
|
458
85
|
</div>
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
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 165</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>
|
86
|
+
<div id='context'>
|
87
|
+
<div id='includes'>
|
88
|
+
<h2>Included modules</h2>
|
89
|
+
<ol>
|
90
|
+
<li>Comparable</li>
|
91
|
+
</ol>
|
92
|
+
</div>
|
486
93
|
</div>
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
</
|
506
|
-
|
507
|
-
<tr
|
508
|
-
|
509
|
-
|
510
|
-
</td
|
511
|
-
</
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
<
|
516
|
-
<
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
</
|
94
|
+
<div id='section'>
|
95
|
+
<div id='constants-list'>
|
96
|
+
<h2>Constants</h2>
|
97
|
+
<div class='name-list'>
|
98
|
+
<table summary='Constants'>
|
99
|
+
<tr class='top-aligned-row context-row'>
|
100
|
+
<td class='context-item-name'>MILLISECONDS_IN_SECOND</td>
|
101
|
+
<td>=</td>
|
102
|
+
<td class='context-item-value'>1000</td>
|
103
|
+
</tr>
|
104
|
+
<tr class='top-aligned-row context-row'>
|
105
|
+
<td class='context-item-name'>MILLISECONDS_IN_MINUTE</td>
|
106
|
+
<td>=</td>
|
107
|
+
<td class='context-item-value'>60 * MILLISECONDS_IN_SECOND</td>
|
108
|
+
</tr>
|
109
|
+
<tr class='top-aligned-row context-row'>
|
110
|
+
<td class='context-item-name'>MILLISECONDS_IN_HOUR</td>
|
111
|
+
<td>=</td>
|
112
|
+
<td class='context-item-value'>60 * MILLISECONDS_IN_MINUTE</td>
|
113
|
+
</tr>
|
114
|
+
<tr class='top-aligned-row context-row'>
|
115
|
+
<td class='context-item-name'>MILLISECONDS_IN_DAY</td>
|
116
|
+
<td>=</td>
|
117
|
+
<td class='context-item-value'>24 * MILLISECONDS_IN_HOUR</td>
|
118
|
+
</tr>
|
119
|
+
</table>
|
120
|
+
</div>
|
121
|
+
</div>
|
122
|
+
<div id='methods'>
|
123
|
+
<h2>Public class methods</h2>
|
124
|
+
<div class='method public-class' id='method-M000010'>
|
125
|
+
<a name='M000010'></a>
|
126
|
+
<div class='synopsis'>
|
127
|
+
<span class='name'>new</span>
|
128
|
+
<span class='arguments'>(*args)</span>
|
129
|
+
</div>
|
130
|
+
<div class='description'>
|
131
|
+
<p>
|
132
|
+
Create an <a href="SdlTimeSpan.html">SdlTimeSpan</a>. Note: if the timespan
|
133
|
+
is negative all components should be negative.
|
134
|
+
</p>
|
135
|
+
<pre>SdlTimeSpan.new(days, hours, minutes, seconds = 0, milliseconds = 0)</pre>
|
136
|
+
<p>
|
137
|
+
or
|
138
|
+
</p>
|
139
|
+
<pre>SdlTimeSpan.new(totalMilliseconds)</pre>
|
140
|
+
</div>
|
141
|
+
<div class='source'>
|
142
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000010-source'); return false">
|
143
|
+
[show source]
|
144
|
+
</a>
|
145
|
+
<pre id='M000010-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 76</span>
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>)
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>
78: <span class="ruby-identifier">initialize_total_milliseconds</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
79: <span class="ruby-keyword kw">else</span>
80: <span class="ruby-identifier">initialize_days_hours_minutes</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
81: <span class="ruby-keyword kw">end</span>
82: <span class="ruby-keyword kw">end</span></pre>
|
146
|
+
</div>
|
147
|
+
</div>
|
148
|
+
<h2>Public instance methods</h2>
|
149
|
+
<div class='method public-instance' id='method-M000035'>
|
150
|
+
<a name='M000035'></a>
|
151
|
+
<div class='synopsis'>
|
152
|
+
<span class='name'><=></span>
|
153
|
+
<span class='arguments'>(other)</span>
|
154
|
+
</div>
|
155
|
+
<div class='source'>
|
156
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000035-source'); return false">
|
157
|
+
[show source]
|
158
|
+
</a>
|
159
|
+
<pre id='M000035-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-operator"><=></span>(<span class="ruby-identifier">other</span>)
230: <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">total_milliseconds</span>
231: <span class="ruby-keyword kw">end</span></pre>
|
160
|
+
</div>
|
161
|
+
</div>
|
162
|
+
<div class='method public-instance' id='method-M000034'>
|
163
|
+
<a name='M000034'></a>
|
164
|
+
<div class='synopsis'>
|
165
|
+
<span class='name'>==</span>
|
166
|
+
<span class='arguments'>(other)</span>
|
167
|
+
</div>
|
168
|
+
<div class='description'>
|
169
|
+
<p>
|
170
|
+
Alias for <a href="SdlTimeSpan.html#M000033">eql?</a>
|
171
|
+
</p>
|
172
|
+
</div>
|
173
|
+
</div>
|
174
|
+
<div class='method public-instance' id='method-M000013'>
|
175
|
+
<a name='M000013'></a>
|
176
|
+
<div class='synopsis'>
|
177
|
+
<span class='name'>day</span>
|
178
|
+
<span class='arguments'>()</span>
|
179
|
+
</div>
|
180
|
+
<div class='description'>
|
181
|
+
<p>
|
182
|
+
Alias for <a href="SdlTimeSpan.html#M000012">days</a>
|
183
|
+
</p>
|
184
|
+
</div>
|
185
|
+
</div>
|
186
|
+
<div class='method public-instance' id='method-M000012'>
|
187
|
+
<a name='M000012'></a>
|
188
|
+
<div class='synopsis'>
|
189
|
+
<span class='name'>days</span>
|
190
|
+
<span class='arguments'>()</span>
|
191
|
+
</div>
|
192
|
+
<div class='description'>
|
193
|
+
<p>
|
194
|
+
The days component.
|
195
|
+
</p>
|
196
|
+
</div>
|
197
|
+
<div class='source'>
|
198
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000012-source'); return false">
|
199
|
+
[show source]
|
200
|
+
</a>
|
201
|
+
<pre id='M000012-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 92</span>
92: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">days</span>
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>)
94: <span class="ruby-keyword kw">end</span></pre>
|
202
|
+
</div>
|
203
|
+
</div>
|
204
|
+
<div class='method public-instance' id='method-M000033'>
|
205
|
+
<a name='M000033'></a>
|
206
|
+
<div class='synopsis'>
|
207
|
+
<span class='name'>eql?</span>
|
208
|
+
<span class='arguments'>(other)</span>
|
209
|
+
</div>
|
210
|
+
<div class='description'>
|
211
|
+
<p>
|
212
|
+
Tests for equivalence.
|
213
|
+
</p>
|
214
|
+
</div>
|
215
|
+
<div class='source'>
|
216
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000033-source'); return false">
|
217
|
+
[show source]
|
218
|
+
</a>
|
219
|
+
<pre id='M000033-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 222</span>
222: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">other</span>)
223: <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>
224: <span class="ruby-keyword kw">end</span></pre>
|
220
|
+
</div>
|
221
|
+
</div>
|
222
|
+
<div class='method public-instance' id='method-M000032'>
|
223
|
+
<a name='M000032'></a>
|
224
|
+
<div class='synopsis'>
|
225
|
+
<span class='name'>hash</span>
|
226
|
+
<span class='arguments'>()</span>
|
227
|
+
</div>
|
228
|
+
<div class='description'>
|
229
|
+
<p>
|
230
|
+
A hashcode based on the canonical string representation.
|
231
|
+
</p>
|
232
|
+
</div>
|
233
|
+
<div class='source'>
|
234
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000032-source'); return false">
|
235
|
+
[show source]
|
236
|
+
</a>
|
237
|
+
<pre id='M000032-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 216</span>
216: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash</span>
217: <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">hash</span>
218: <span class="ruby-keyword kw">end</span></pre>
|
238
|
+
</div>
|
239
|
+
</div>
|
240
|
+
<div class='method public-instance' id='method-M000015'>
|
241
|
+
<a name='M000015'></a>
|
242
|
+
<div class='synopsis'>
|
243
|
+
<span class='name'>hour</span>
|
244
|
+
<span class='arguments'>()</span>
|
245
|
+
</div>
|
246
|
+
<div class='description'>
|
247
|
+
<p>
|
248
|
+
Alias for <a href="SdlTimeSpan.html#M000014">hours</a>
|
249
|
+
</p>
|
250
|
+
</div>
|
251
|
+
</div>
|
252
|
+
<div class='method public-instance' id='method-M000014'>
|
253
|
+
<a name='M000014'></a>
|
254
|
+
<div class='synopsis'>
|
255
|
+
<span class='name'>hours</span>
|
256
|
+
<span class='arguments'>()</span>
|
257
|
+
</div>
|
258
|
+
<div class='description'>
|
259
|
+
<p>
|
260
|
+
The hours component.
|
261
|
+
</p>
|
262
|
+
</div>
|
263
|
+
<div class='source'>
|
264
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000014-source'); return false">
|
265
|
+
[show source]
|
266
|
+
</a>
|
267
|
+
<pre id='M000014-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 99</span>
 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hours</span>
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>)
101: <span class="ruby-keyword kw">end</span></pre>
|
268
|
+
</div>
|
269
|
+
</div>
|
270
|
+
<div class='method public-instance' id='method-M000020'>
|
271
|
+
<a name='M000020'></a>
|
272
|
+
<div class='synopsis'>
|
273
|
+
<span class='name'>milliseconds</span>
|
274
|
+
<span class='arguments'>()</span>
|
275
|
+
</div>
|
276
|
+
<div class='description'>
|
277
|
+
<p>
|
278
|
+
The milliseconds component.
|
279
|
+
</p>
|
280
|
+
</div>
|
281
|
+
<div class='source'>
|
282
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000020-source'); return false">
|
283
|
+
[show source]
|
284
|
+
</a>
|
285
|
+
<pre id='M000020-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 125</span>
125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">milliseconds</span>
126: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator">-</span>
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>
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>
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>
130: (<span class="ruby-identifier">seconds</span> <span class="ruby-operator">*</span> <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)
131: <span class="ruby-keyword kw">end</span></pre>
|
286
|
+
</div>
|
287
|
+
</div>
|
288
|
+
<div class='method public-instance' id='method-M000017'>
|
289
|
+
<a name='M000017'></a>
|
290
|
+
<div class='synopsis'>
|
291
|
+
<span class='name'>min</span>
|
292
|
+
<span class='arguments'>()</span>
|
293
|
+
</div>
|
294
|
+
<div class='description'>
|
295
|
+
<p>
|
296
|
+
Alias for <a href="SdlTimeSpan.html#M000016">minutes</a>
|
297
|
+
</p>
|
298
|
+
</div>
|
299
|
+
</div>
|
300
|
+
<div class='method public-instance' id='method-M000016'>
|
301
|
+
<a name='M000016'></a>
|
302
|
+
<div class='synopsis'>
|
303
|
+
<span class='name'>minutes</span>
|
304
|
+
<span class='arguments'>()</span>
|
305
|
+
</div>
|
306
|
+
<div class='description'>
|
307
|
+
<p>
|
308
|
+
The minutes component.
|
309
|
+
</p>
|
310
|
+
</div>
|
311
|
+
<div class='source'>
|
312
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000016-source'); return false">
|
313
|
+
[show source]
|
314
|
+
</a>
|
315
|
+
<pre id='M000016-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 106</span>
106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">minutes</span>
107: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>
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>
109: <span class="ruby-constant">MILLISECONDS_IN_MINUTE</span>)
110: <span class="ruby-keyword kw">end</span></pre>
|
316
|
+
</div>
|
317
|
+
</div>
|
318
|
+
<div class='method public-instance' id='method-M000026'>
|
319
|
+
<a name='M000026'></a>
|
320
|
+
<div class='synopsis'>
|
321
|
+
<span class='name'>negate</span>
|
322
|
+
<span class='arguments'>()</span>
|
323
|
+
</div>
|
324
|
+
<div class='description'>
|
325
|
+
<p>
|
326
|
+
Returns an new <a href="SdlTimeSpan.html">SdlTimeSpan</a> instance that is
|
327
|
+
the opposite of this instance
|
328
|
+
</p>
|
329
|
+
</div>
|
330
|
+
<div class='source'>
|
331
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000026-source'); return false">
|
332
|
+
[show source]
|
333
|
+
</a>
|
334
|
+
<pre id='M000026-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 165</span>
165: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">negate</span>
166: <span class="ruby-constant">SdlTimeSpan</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">-</span><span class="ruby-ivar">@totalMilliseconds</span>)
167: <span class="ruby-keyword kw">end</span></pre>
|
335
|
+
</div>
|
336
|
+
</div>
|
337
|
+
<div class='method public-instance' id='method-M000027'>
|
338
|
+
<a name='M000027'></a>
|
339
|
+
<div class='synopsis'>
|
340
|
+
<span class='name'>roll_days</span>
|
341
|
+
<span class='arguments'>(days)</span>
|
342
|
+
</div>
|
343
|
+
<div class='description'>
|
344
|
+
<p>
|
345
|
+
Return a new instance with the days adjusted by the given amount. Positive
|
346
|
+
numbers add days. Negative numbers remove days.
|
347
|
+
</p>
|
348
|
+
<table>
|
349
|
+
<tr><td valign="top"><tt>days</tt>:</td><td>The adjustment (days to add or subtract)
|
350
|
+
|
351
|
+
</td></tr>
|
352
|
+
</table>
|
353
|
+
</div>
|
354
|
+
<div class='source'>
|
355
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000027-source'); return false">
|
356
|
+
[show source]
|
357
|
+
</a>
|
358
|
+
<pre id='M000027-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 174</span>
174: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_days</span>(<span class="ruby-identifier">days</span>)
175: <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>))
176: <span class="ruby-keyword kw">end</span></pre>
|
359
|
+
</div>
|
360
|
+
</div>
|
361
|
+
<div class='method public-instance' id='method-M000028'>
|
362
|
+
<a name='M000028'></a>
|
363
|
+
<div class='synopsis'>
|
364
|
+
<span class='name'>roll_hours</span>
|
365
|
+
<span class='arguments'>(hours)</span>
|
366
|
+
</div>
|
367
|
+
<div class='description'>
|
368
|
+
<p>
|
369
|
+
Return a new instance with the hours adjusted by the given amount. Positive
|
370
|
+
numbers add hours. Negative numbers remove hours.
|
371
|
+
</p>
|
372
|
+
<table>
|
373
|
+
<tr><td valign="top"><tt>hours</tt>:</td><td>The adjustment (hours to add or subtract)
|
374
|
+
|
375
|
+
</td></tr>
|
376
|
+
</table>
|
377
|
+
</div>
|
378
|
+
<div class='source'>
|
379
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000028-source'); return false">
|
380
|
+
[show source]
|
381
|
+
</a>
|
382
|
+
<pre id='M000028-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 183</span>
183: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_hours</span>(<span class="ruby-identifier">hours</span>)
184: <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>))
185: <span class="ruby-keyword kw">end</span></pre>
|
383
|
+
</div>
|
384
|
+
</div>
|
385
|
+
<div class='method public-instance' id='method-M000031'>
|
386
|
+
<a name='M000031'></a>
|
387
|
+
<div class='synopsis'>
|
388
|
+
<span class='name'>roll_milliseconds</span>
|
389
|
+
<span class='arguments'>(milliseconds)</span>
|
390
|
+
</div>
|
391
|
+
<div class='description'>
|
392
|
+
<p>
|
393
|
+
Return a new instance with the milliseconds adjusted by the given amount.
|
394
|
+
Positive numbers add milliseconds. Negative numbers remove milliseconds.
|
395
|
+
</p>
|
396
|
+
<table>
|
397
|
+
<tr><td valign="top"><tt>milliseconds</tt>:</td><td>The adjustment (milliseconds to add or subtract)
|
398
|
+
|
399
|
+
</td></tr>
|
400
|
+
</table>
|
401
|
+
</div>
|
402
|
+
<div class='source'>
|
403
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000031-source'); return false">
|
404
|
+
[show source]
|
405
|
+
</a>
|
406
|
+
<pre id='M000031-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 210</span>
210: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_milliseconds</span>(<span class="ruby-identifier">milliseconds</span>)
211: <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>)
212: <span class="ruby-keyword kw">end</span></pre>
|
407
|
+
</div>
|
408
|
+
</div>
|
409
|
+
<div class='method public-instance' id='method-M000029'>
|
410
|
+
<a name='M000029'></a>
|
411
|
+
<div class='synopsis'>
|
412
|
+
<span class='name'>roll_minutes</span>
|
413
|
+
<span class='arguments'>(minutes)</span>
|
414
|
+
</div>
|
415
|
+
<div class='description'>
|
416
|
+
<p>
|
417
|
+
Return a new instance with the minutes adjusted by the given amount.
|
418
|
+
Positive numbers add minutes. Negative numbers remove minutes.
|
419
|
+
</p>
|
420
|
+
<table>
|
421
|
+
<tr><td valign="top"><tt>minutes</tt>:</td><td>The adjustment (minutes to add or subtract)
|
422
|
+
|
423
|
+
</td></tr>
|
424
|
+
</table>
|
425
|
+
</div>
|
426
|
+
<div class='source'>
|
427
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000029-source'); return false">
|
428
|
+
[show source]
|
429
|
+
</a>
|
430
|
+
<pre id='M000029-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 192</span>
192: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_minutes</span>(<span class="ruby-identifier">minutes</span>)
193: <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>))
194: <span class="ruby-keyword kw">end</span></pre>
|
431
|
+
</div>
|
432
|
+
</div>
|
433
|
+
<div class='method public-instance' id='method-M000030'>
|
434
|
+
<a name='M000030'></a>
|
435
|
+
<div class='synopsis'>
|
436
|
+
<span class='name'>roll_seconds</span>
|
437
|
+
<span class='arguments'>(seconds)</span>
|
438
|
+
</div>
|
439
|
+
<div class='description'>
|
440
|
+
<p>
|
441
|
+
Return a new instance with the seconds adjusted by the given amount.
|
442
|
+
Positive numbers add seconds. Negative numbers remove seconds.
|
443
|
+
</p>
|
444
|
+
<table>
|
445
|
+
<tr><td valign="top"><tt>seconds</tt>:</td><td>The adjustment (seconds to add or subtract)
|
446
|
+
|
447
|
+
</td></tr>
|
448
|
+
</table>
|
449
|
+
</div>
|
450
|
+
<div class='source'>
|
451
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000030-source'); return false">
|
452
|
+
[show source]
|
453
|
+
</a>
|
454
|
+
<pre id='M000030-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 201</span>
201: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">roll_seconds</span>(<span class="ruby-identifier">seconds</span>)
202: <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>))
203: <span class="ruby-keyword kw">end</span></pre>
|
455
|
+
</div>
|
456
|
+
</div>
|
457
|
+
<div class='method public-instance' id='method-M000019'>
|
458
|
+
<a name='M000019'></a>
|
459
|
+
<div class='synopsis'>
|
460
|
+
<span class='name'>sec</span>
|
461
|
+
<span class='arguments'>()</span>
|
462
|
+
</div>
|
463
|
+
<div class='description'>
|
464
|
+
<p>
|
465
|
+
Alias for <a href="SdlTimeSpan.html#M000018">seconds</a>
|
466
|
+
</p>
|
467
|
+
</div>
|
468
|
+
</div>
|
469
|
+
<div class='method public-instance' id='method-M000018'>
|
470
|
+
<a name='M000018'></a>
|
471
|
+
<div class='synopsis'>
|
472
|
+
<span class='name'>seconds</span>
|
473
|
+
<span class='arguments'>()</span>
|
474
|
+
</div>
|
475
|
+
<div class='description'>
|
476
|
+
<p>
|
477
|
+
The seconds component.
|
478
|
+
</p>
|
479
|
+
</div>
|
480
|
+
<div class='source'>
|
481
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000018-source'); return false">
|
482
|
+
[show source]
|
483
|
+
</a>
|
484
|
+
<pre id='M000018-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 115</span>
115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">seconds</span>
116: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sign</span> <span class="ruby-operator">*</span>
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>
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>
119: <span class="ruby-constant">MILLISECONDS_IN_SECOND</span>)
120: <span class="ruby-keyword kw">end</span></pre>
|
485
|
+
</div>
|
486
|
+
</div>
|
487
|
+
<div class='method public-instance' id='method-M000011'>
|
488
|
+
<a name='M000011'></a>
|
489
|
+
<div class='synopsis'>
|
490
|
+
<span class='name'>sign</span>
|
491
|
+
<span class='arguments'>()</span>
|
492
|
+
</div>
|
493
|
+
<div class='description'>
|
494
|
+
<p>
|
495
|
+
Returns the sign (-1 or +1) of this <a
|
496
|
+
href="SdlTimeSpan.html">SdlTimeSpan</a>.
|
497
|
+
</p>
|
498
|
+
</div>
|
499
|
+
<div class='source'>
|
500
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000011-source'); return false">
|
501
|
+
[show source]
|
502
|
+
</a>
|
503
|
+
<pre id='M000011-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 86</span>
86: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sign</span>
87: <span class="ruby-ivar">@totalMilliseconds</span> <span class="ruby-operator"><=></span> <span class="ruby-value">0</span>
88: <span class="ruby-keyword kw">end</span></pre>
|
504
|
+
</div>
|
505
|
+
</div>
|
506
|
+
<div class='method public-instance' id='method-M000036'>
|
507
|
+
<a name='M000036'></a>
|
508
|
+
<div class='synopsis'>
|
509
|
+
<span class='name'>to_s</span>
|
510
|
+
<span class='arguments'>()</span>
|
511
|
+
</div>
|
512
|
+
<div class='description'>
|
513
|
+
<p>
|
514
|
+
Returns an SDL representation of this time span using the format:
|
515
|
+
</p>
|
516
|
+
<pre>(days:)hours:minutes:seconds(.milliseconds)</pre>
|
517
|
+
<p>
|
518
|
+
(parenthesis indicate optional components)
|
519
|
+
</p>
|
520
|
+
<p>
|
521
|
+
The days and milliseconds components will not be included if they are set
|
522
|
+
to 0. Days must be suffixed with “d” for clarity.
|
523
|
+
</p>
|
524
|
+
<p>
|
525
|
+
Hours, minutes, and seconds will be zero paded to two characters.
|
526
|
+
</p>
|
527
|
+
<p>
|
528
|
+
Examples:
|
529
|
+
</p>
|
530
|
+
<pre>23:13:00 (12 hours and 13 minutes)
24d:12:13:09.234 (24 days, 12 hours, 13 minutes, 9 seconds,
 234 milliseconds)</pre>
|
531
|
+
</div>
|
532
|
+
<div class='source'>
|
533
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000036-source'); return false">
|
534
|
+
[show source]
|
535
|
+
</a>
|
536
|
+
<pre id='M000036-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 250</span>
250: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
251: <span class="ruby-identifier">_days</span> = <span class="ruby-identifier">days</span>
252: <span class="ruby-identifier">_milliseconds</span> = <span class="ruby-identifier">milliseconds</span>
253: 
254: <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">nil</span>
255: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_days</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
256: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
257: <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>)
258: <span class="ruby-keyword kw">else</span>
259: <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>)
260: <span class="ruby-keyword kw">end</span>
261: <span class="ruby-keyword kw">else</span>
262: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_milliseconds</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
263: <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>)
264: <span class="ruby-keyword kw">else</span>
265: <span class="ruby-identifier">s</span> = <span class="ruby-identifier">sprintf</span>(
266: <span class="ruby-value str">"%dd:%02d:%02d:%02d.%03d"</span>,
267: <span class="ruby-identifier">_days</span>,
268: <span class="ruby-identifier">hours</span>.<span class="ruby-identifier">abs</span>,
269: <span class="ruby-identifier">minutes</span>.<span class="ruby-identifier">abs</span>,
270: <span class="ruby-identifier">seconds</span>.<span class="ruby-identifier">abs</span>,
271: <span class="ruby-identifier">_milliseconds</span>.<span class="ruby-identifier">abs</span>)
272: <span class="ruby-keyword kw">end</span>
273: <span class="ruby-keyword kw">end</span>
274: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">s</span>
275: <span class="ruby-keyword kw">end</span></pre>
|
537
|
+
</div>
|
538
|
+
</div>
|
539
|
+
<div class='method public-instance' id='method-M000022'>
|
540
|
+
<a name='M000022'></a>
|
541
|
+
<div class='synopsis'>
|
542
|
+
<span class='name'>total_hours</span>
|
543
|
+
<span class='arguments'>()</span>
|
544
|
+
</div>
|
545
|
+
<div class='description'>
|
546
|
+
<p>
|
547
|
+
Get the total number of hours in this time span. For example, if this time
|
548
|
+
span represents two days, this method will return 48.
|
549
|
+
</p>
|
550
|
+
</div>
|
551
|
+
<div class='source'>
|
552
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000022-source'); return false">
|
553
|
+
[show source]
|
554
|
+
</a>
|
555
|
+
<pre id='M000022-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 137</span>
137: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_hours</span>
138: <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>)
139: <span class="ruby-keyword kw">end</span></pre>
|
556
|
+
</div>
|
557
|
+
</div>
|
558
|
+
<div class='method public-instance' id='method-M000025'>
|
559
|
+
<a name='M000025'></a>
|
560
|
+
<div class='synopsis'>
|
561
|
+
<span class='name'>total_milliseconds</span>
|
562
|
+
<span class='arguments'>()</span>
|
563
|
+
</div>
|
564
|
+
<div class='description'>
|
565
|
+
<p>
|
566
|
+
Get the total number of milliseconds in this time span. For example, if
|
567
|
+
this time span represents 4 seconds, this method will return 4000.
|
568
|
+
</p>
|
569
|
+
</div>
|
570
|
+
<div class='source'>
|
571
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000025-source'); return false">
|
572
|
+
[show source]
|
573
|
+
</a>
|
574
|
+
<pre id='M000025-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 158</span>
158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_milliseconds</span>
159: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@totalMilliseconds</span>
160: <span class="ruby-keyword kw">end</span></pre>
|
575
|
+
</div>
|
576
|
+
</div>
|
577
|
+
<div class='method public-instance' id='method-M000023'>
|
578
|
+
<a name='M000023'></a>
|
579
|
+
<div class='synopsis'>
|
580
|
+
<span class='name'>total_minutes</span>
|
581
|
+
<span class='arguments'>()</span>
|
582
|
+
</div>
|
583
|
+
<div class='description'>
|
584
|
+
<p>
|
585
|
+
Get the total number of minutes in this time span. For example, if this
|
586
|
+
time span represents two hours, this method will return 120.
|
587
|
+
</p>
|
588
|
+
</div>
|
589
|
+
<div class='source'>
|
590
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000023-source'); return false">
|
591
|
+
[show source]
|
592
|
+
</a>
|
593
|
+
<pre id='M000023-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 144</span>
144: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_minutes</span>
145: <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>)
146: <span class="ruby-keyword kw">end</span></pre>
|
594
|
+
</div>
|
595
|
+
</div>
|
596
|
+
<div class='method public-instance' id='method-M000024'>
|
597
|
+
<a name='M000024'></a>
|
598
|
+
<div class='synopsis'>
|
599
|
+
<span class='name'>total_seconds</span>
|
600
|
+
<span class='arguments'>()</span>
|
601
|
+
</div>
|
602
|
+
<div class='description'>
|
603
|
+
<p>
|
604
|
+
Get the total number of seconds in this time span. For example, if this
|
605
|
+
time span represents three minutes, this method will return 180.
|
606
|
+
</p>
|
607
|
+
</div>
|
608
|
+
<div class='source'>
|
609
|
+
<a class='source-toggle' href='#' onclick="toggleCode('M000024-source'); return false">
|
610
|
+
[show source]
|
611
|
+
</a>
|
612
|
+
<pre id='M000024-source'> <span class="ruby-comment cmt"># File lib/sdl4r/sdl_time_span.rb, line 151</span>
151: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_seconds</span>
152: <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>)
153: <span class="ruby-keyword kw">end</span></pre>
|
613
|
+
</div>
|
614
|
+
</div>
|
615
|
+
<div class='method public-instance' id='method-M000021'>
|
616
|
+
<a name='M000021'></a>
|
617
|
+
<div class='synopsis'>
|
618
|
+
<span class='name'>usec</span>
|
619
|
+
<span class='arguments'>()</span>
|
620
|
+
</div>
|
621
|
+
<div class='description'>
|
622
|
+
<p>
|
623
|
+
Alias for <a href="SdlTimeSpan.html#M000020">milliseconds</a>
|
624
|
+
</p>
|
625
|
+
</div>
|
626
|
+
</div>
|
627
|
+
</div>
|
521
628
|
</div>
|
522
629
|
</div>
|
523
630
|
</div>
|
524
|
-
|
525
|
-
|
526
|
-
|
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 183</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 210</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 192</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 201</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 115</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 86</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 250</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 137</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 158</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 144</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 151</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
|
-
|
631
|
+
<div id='footer-push'></div>
|
632
|
+
</div>
|
633
|
+
<div id='footer'>
|
634
|
+
<a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
|
937
635
|
</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>
|
636
|
+
</body>
|
637
|
+
</html>
|