1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::fnd::TimeSpan</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/fnd/Overview.html">fnd</a>::TimeSpan</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class TimeSpan</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Represents the length of time.</p><p>Within this class, time is expressed in nanoseconds using 64-bit integers. This class is used to prevent unit mistakes in the values that are passed to functions that specify time within the SDK. The <CODE>From*</CODE> functions allow you to create instances of this class from integer values of the various units. In order to prevent ambiguity in units, no implicit conversion from integers to this data type is provided. However, 0 can be converted implicitly to this data type.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66<th class="category" colspan="3">Constructor</th> 67 </tr> 68 <tr> 69 <td width="100"> </td> 70 <th> 71<a href="../../../nn/fnd/TimeSpan/TimeSpan.html"><CODE>TimeSpan</CODE></a> 72 </th> 73<td>Constructor that initializes the time to 0.</td> 74 </tr> 75 <tr> 76 <td width="100"> 77<span class="static_style" title="static">S</span> </td> 78 <th> 79<a href="../../../nn/fnd/TimeSpan/FromNanoSeconds.html"><CODE>FromNanoSeconds</CODE></a> 80 </th> 81<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a nanoseconds value.</td> 82 </tr> 83 <tr> 84 <td width="100"> 85<span class="static_style" title="static">S</span> </td> 86 <th> 87<a href="../../../nn/fnd/TimeSpan/FromMicroSeconds.html"><CODE>FromMicroSeconds</CODE></a> 88 </th> 89<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a microseconds value.</td> 90 </tr> 91 <tr> 92 <td width="100"> 93<span class="static_style" title="static">S</span> </td> 94 <th> 95<a href="../../../nn/fnd/TimeSpan/FromMilliSeconds.html"><CODE>FromMilliSeconds</CODE></a> 96 </th> 97<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a milliseconds value.</td> 98 </tr> 99 <tr> 100 <td width="100"> 101<span class="static_style" title="static">S</span> </td> 102 <th> 103<a href="../../../nn/fnd/TimeSpan/FromSeconds.html"><CODE>FromSeconds</CODE></a> 104 </th> 105<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a seconds value.</td> 106 </tr> 107 <tr> 108 <td width="100"> 109<span class="static_style" title="static">S</span> </td> 110 <th> 111<a href="../../../nn/fnd/TimeSpan/FromMinutes.html"><CODE>FromMinutes</CODE></a> 112 </th> 113<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a minutes value.</td> 114 </tr> 115 <tr> 116 <td width="100"> 117<span class="static_style" title="static">S</span> </td> 118 <th> 119<a href="../../../nn/fnd/TimeSpan/FromHours.html"><CODE>FromHours</CODE></a> 120 </th> 121<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from an hours value.</td> 122 </tr> 123 <tr> 124 <td width="100"> 125<span class="static_style" title="static">S</span> </td> 126 <th> 127<a href="../../../nn/fnd/TimeSpan/FromDays.html"><CODE>FromDays</CODE></a> 128 </th> 129<td>Generates a <a href="../../../nn/fnd/TimeSpan/Overview.html"><CODE>TimeSpan</CODE></a> object from a days value.</td> 130 </tr> 131 <tr> 132<th class="category" colspan="3">Gets the value in specific units</th> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137<a href="../../../nn/fnd/TimeSpan/GetDays.html"><CODE>GetDays</CODE></a> 138 </th> 139<td>Gets the time in days.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144<a href="../../../nn/fnd/TimeSpan/GetHours.html"><CODE>GetHours</CODE></a> 145 </th> 146<td>Gets the time in hours.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151<a href="../../../nn/fnd/TimeSpan/GetMinutes.html"><CODE>GetMinutes</CODE></a> 152 </th> 153<td>Gets the time in minutes.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158<a href="../../../nn/fnd/TimeSpan/GetSeconds.html"><CODE>GetSeconds</CODE></a> 159 </th> 160<td>Gets the time in seconds.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165<a href="../../../nn/fnd/TimeSpan/GetMilliSeconds.html"><CODE>GetMilliSeconds</CODE></a> 166 </th> 167<td>Gets the time in milliseconds.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172<a href="../../../nn/fnd/TimeSpan/GetMicroSeconds.html"><CODE>GetMicroSeconds</CODE></a> 173 </th> 174<td>Gets the time in microseconds.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179<a href="../../../nn/fnd/TimeSpan/GetNanoSeconds.html"><CODE>GetNanoSeconds</CODE></a> 180 </th> 181<td>Gets the time in nanoseconds.</td> 182 </tr> 183 <tr> 184<th class="category" colspan="3">Other</th> 185 </tr> 186 <tr> 187 <td width="100"> </td> 188 <th> 189<a href="../../../nn/fnd/TimeSpan/operator+=.html"><CODE>operator+=</CODE> </a> 190 </th> 191<td>Adds the length of time.</td> 192 </tr> 193 <tr> 194 <td width="100"> </td> 195 <th> 196<a href="../../../nn/fnd/TimeSpan/operator-2d=.html"><CODE>operator-=</CODE> </a> 197 </th> 198<td>Subtracts the length of time.</td> 199 </tr> </table> 200 </div> 201 </a> <a name="function" id="function"> 202 <h2> 203Friend functions 204 </h2> 205 <div class="section"> 206 <table class="members"> 207 <tr> 208 <td width="100"> </td> 209 <th> 210<a href="../../../nn/fnd/TimeSpan/operator==.html"><CODE>operator==</CODE> </a> 211 </th> 212<td>Determines whether the lengths of time match.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<a href="../../../nn/fnd/TimeSpan/operator!=.html"><CODE>operator!=</CODE> </a> 218 </th> 219<td>Determines whether the lengths of time do not match.</td> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224<a href="../../../nn/fnd/TimeSpan/operator-3c.html"><CODE>operator<</CODE> </a> 225 </th> 226<td>Determines if the length of time is shorter.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<a href="../../../nn/fnd/TimeSpan/operator-3e.html"><CODE>operator></CODE> </a> 232 </th> 233<td>Determines if the length of time is longer.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238<a href="../../../nn/fnd/TimeSpan/operator-3c=.html"><CODE>operator<=</CODE> </a> 239 </th> 240<td>Determines if the length of time is shorter or equal.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245<a href="../../../nn/fnd/TimeSpan/operator-3e=.html"><CODE>operator>=</CODE> </a> 246 </th> 247<td>Determines if the length of time is longer or equal.</td> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252<a href="../../../nn/fnd/TimeSpan/operator+.html"><CODE>operator+</CODE> </a> 253 </th> 254<td>Finds the sum of lengths of time.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259<a href="../../../nn/fnd/TimeSpan/operator-2d.html"><CODE>operator-</CODE> </a> 260 </th> 261<td>Finds the difference in lengths of time.</td> 262 </tr> </table> 263 </div> 264 </a> 265<h2>Revision History</h2> 266 <div class="section"> 267 <dl class="history"> 268 <dt>2012/05/25</dt> 269<dd>Categorized the member functions.<br />Added the operator-series functions.<br /> 270 </dd> 271 <dt>2010/01/07</dt> 272<dd>Initial version.<br /> 273 </dd> 274 </dl> 275 </div> 276 <hr><p>CONFIDENTIAL</p></body> 277</html>