1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>TimeValue class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>TimeValue Class Reference<br> 10 <small> 11 [<a class="el" href="group__osclbase.html">OSCL Base</a>]</small> 12 </h1>The TimeValue class represents a time value in a format native to the system. 13 <a href="#_details">More...</a> 14 <p> 15 <code>#include <<a class="el" href="oscl__time_8h-source.html">oscl_time.h</a>></code> 16 <p> 17 <table border=0 cellpadding=0 cellspacing=0> 18 <tr><td></td></tr> 19 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 20 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF </td><td valign=bottom><a class="el" href="classTimeValue.html#a0">TimeValue</a> ()</td></tr> 21 <tr><td> </td><td><font size=-1><em>Create a TimeValue representing the current time.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> 22 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF </td><td valign=bottom><a class="el" href="classTimeValue.html#a1">TimeValue</a> (const TimeValue &Tv)</td></tr> 23 <tr><td> </td><td><font size=-1><em>Copy constructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> 24 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF </td><td valign=bottom><a class="el" href="classTimeValue.html#a2">TimeValue</a> (long tv, <a class="el" href="group__osclbase.html#a109">TimeUnits</a> units)</td></tr> 25 <tr><td> </td><td><font size=-1><em>Create a TimeValue representing an interval of tv units.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> 26 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF </td><td valign=bottom><a class="el" href="classTimeValue.html#a3">TimeValue</a> (const <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a> &in_tv)</td></tr> 27 <tr><td> </td><td><font size=-1><em>Create a TimeValue representing the absolute time specified by the BasicTimeStruct.</em> <a href="#a3"></a><em></em></font><br><br></td></tr> 28 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF </td><td valign=bottom><a class="el" href="classTimeValue.html#a4">TimeValue</a> (<a class="el" href="osclconfig__time_8h.html#a2">OsclBasicDateTimeStruct</a> in_ts)</td></tr> 29 <tr><td> </td><td><font size=-1><em>Create a TimeValue representing the absolute time specified by the BasicDateTimeStruct.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> 30 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classTimeValue.html#a5">get_local_time</a> ()</td></tr> 31 <tr><td> </td><td><font size=-1><em>Get the local time after having adjusted for daylight saving.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> 32 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void </td><td valign=bottom><a class="el" href="classTimeValue.html#a6">set_to_zero</a> ()</td></tr> 33 <tr><td> </td><td><font size=-1><em>Set the time value to zero (represents a zero interval).</em> <a href="#a6"></a><em></em></font><br><br></td></tr> 34 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void </td><td valign=bottom><a class="el" href="classTimeValue.html#a7">set_to_current_time</a> ()</td></tr> 35 <tr><td> </td><td><font size=-1><em>Set the time value to the current system time.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> 36 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void </td><td valign=bottom><a class="el" href="classTimeValue.html#a8">set_from_ntp_time</a> (const uint32 ntp_offset)</td></tr> 37 <tr><td> </td><td><font size=-1><em>This method coverts a 32-bit NTP offset to system time.</em> <a href="#a8"></a><em></em></font><br><br></td></tr> 38 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF uint32 </td><td valign=bottom><a class="el" href="classTimeValue.html#a9">get_sec</a> () const</td></tr> 39 <tr><td> </td><td><font size=-1><em>Get a 32 bit value representing the seconds since the (system dependent) epoch.</em> <a href="#a9"></a><em></em></font><br><br></td></tr> 40 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classTimeValue.html#a10">to_msec</a> () const</td></tr> 41 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF uint32 </td><td valign=bottom><a class="el" href="classTimeValue.html#a11">get_usec</a> () const</td></tr> 42 <tr><td> </td><td><font size=-1><em>Get a 32 bit value representing the number of microseconds in the time value.</em> <a href="#a11"></a><em></em></font><br><br></td></tr> 43 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF char * </td><td valign=bottom><a class="el" href="classTimeValue.html#a12">get_str_ctime</a> (<a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a> ctime_strbuf)</td></tr> 44 <tr><td> </td><td><font size=-1><em>Get a string containing a text representation of this TimeValue object.</em> <a href="#a12"></a><em></em></font><br><br></td></tr> 45 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int </td><td valign=bottom><a class="el" href="classTimeValue.html#a13">get_pv8601_str_time</a> (<a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a> time_strbuf)</td></tr> 46 <tr><td> </td><td><font size=-1><em>Get a PV extended text representation of the Time based on the ISO 8601 format.</em> <a href="#a13"></a><em></em></font><br><br></td></tr> 47 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF char * </td><td valign=bottom><a class="el" href="classTimeValue.html#a14">get_rfc822_gmtime_str</a> (int max_time_strlen, char *time_str)</td></tr> 48 <tr><td> </td><td><font size=-1><em>Get a text representation of the time in the GMT timezone based on the RFC 822 / RFC 1123 (also described in the HTTP spec RFC 2068 and RFC 2616.</em> <a href="#a14"></a><em></em></font><br><br></td></tr> 49 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classTimeValue.html#a15">is_zero</a> ()</td></tr> 50 <tr><td> </td><td><font size=-1><em>Determine if the time value is zero.</em> <a href="#a15"></a><em></em></font><br><br></td></tr> 51 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue & </td><td valign=bottom><a class="el" href="classTimeValue.html#a16">operator=</a> (const TimeValue &a)</td></tr> 52 <tr><td> </td><td><font size=-1><em>Assignment operator.</em> <a href="#a16"></a><em></em></font><br><br></td></tr> 53 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue & </td><td valign=bottom><a class="el" href="classTimeValue.html#a17">operator+=</a> (const TimeValue &a)</td></tr> 54 <tr><td> </td><td><font size=-1><em>+= operator</em> <a href="#a17"></a><em></em></font><br><br></td></tr> 55 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue & </td><td valign=bottom><a class="el" href="classTimeValue.html#a18">operator-=</a> (const TimeValue &a)</td></tr> 56 <tr><td> </td><td><font size=-1><em>-= operator</em> <a href="#a18"></a><em></em></font><br><br></td></tr> 57 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue & </td><td valign=bottom><a class="el" href="classTimeValue.html#a19">operator *=</a> (const int scale)</td></tr> 58 <tr><td> </td><td><font size=-1><em>This operator scales the time value by a constant.</em> <a href="#a19"></a><em></em></font><br><br></td></tr> 59 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a> * </td><td valign=bottom><a class="el" href="classTimeValue.html#a20">get_timeval_ptr</a> ()</td></tr> 60 <tr><td colspan=2><br><h2>Friends</h2></td></tr> 61 <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classTimeValue.html#l0">NTPTime</a></td></tr> 62 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 63 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l1">operator==</a> (const TimeValue &a, const TimeValue &b)</td></tr> 64 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 65 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l2">operator!=</a> (const TimeValue &a, const TimeValue &b)</td></tr> 66 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 67 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l3">operator<=</a> (const TimeValue &a, const TimeValue &b)</td></tr> 68 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 69 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l4">operator>=</a> (const TimeValue &a, const TimeValue &b)</td></tr> 70 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 71 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l5">operator<</a> (const TimeValue &a, const TimeValue &b)</td></tr> 72 <tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br> 73 bool </td><td valign=bottom><a class="el" href="classTimeValue.html#l6">operator></a> (const TimeValue &a, const TimeValue &b)</td></tr> 74 </table> 75 <hr><a name="_details"></a><h2>Detailed Description</h2> 76 The TimeValue class represents a time value in a format native to the system. 77 <p> 78 This class provides common time functions independent of any OS. The actual representation used is native to the system that the class is compiled on to increase efficiency. Macros used in this class:<ul> 79 <li>OSCL_HAS_ANSI_STRING_SUPPORT:</ul> 80 Definitions to determine the type of basic time structure used to store the time<ul> 81 <li>OSCL_HAS_UNIX_TIME_FUNCS<li>OSCL_HAS_SYMBIAN_SUPPORT<li>OSCL_HAS_MSWIN_SUPPORT </ul> 82 83 <p> 84 <hr><h2>Constructor & Destructor Documentation</h2> 85 <a name="a0" doxytag="TimeValue::TimeValue"></a><p> 86 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 87 <tr> 88 <td class="md"> 89 <table cellpadding="0" cellspacing="0" border="0"> 90 <tr> 91 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td> 92 <td class="md" valign="top">( </td> 93 <td class="mdname1" valign="top" nowrap> </td> 94 <td class="md" valign="top">) </td> 95 <td class="md" nowrap></td> 96 </tr> 97 98 </table> 99 </td> 100 </tr> 101 </table> 102 <table cellspacing=5 cellpadding=0 border=0> 103 <tr> 104 <td> 105 106 </td> 107 <td> 108 109 <p> 110 Create a TimeValue representing the current time. 111 <p> 112 </td> 113 </tr> 114 </table> 115 <a name="a1" doxytag="TimeValue::TimeValue"></a><p> 116 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 117 <tr> 118 <td class="md"> 119 <table cellpadding="0" cellspacing="0" border="0"> 120 <tr> 121 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td> 122 <td class="md" valign="top">( </td> 123 <td class="md" nowrap valign="top">const TimeValue & </td> 124 <td class="mdname1" valign="top" nowrap> <em>Tv</em> </td> 125 <td class="md" valign="top">) </td> 126 <td class="md" nowrap></td> 127 </tr> 128 129 </table> 130 </td> 131 </tr> 132 </table> 133 <table cellspacing=5 cellpadding=0 border=0> 134 <tr> 135 <td> 136 137 </td> 138 <td> 139 140 <p> 141 Copy constructor. 142 <p> 143 </td> 144 </tr> 145 </table> 146 <a name="a2" doxytag="TimeValue::TimeValue"></a><p> 147 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 148 <tr> 149 <td class="md"> 150 <table cellpadding="0" cellspacing="0" border="0"> 151 <tr> 152 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td> 153 <td class="md" valign="top">( </td> 154 <td class="md" nowrap valign="top">long </td> 155 <td class="mdname" nowrap> <em>tv</em>, </td> 156 </tr> 157 <tr> 158 <td></td> 159 <td></td> 160 <td class="md" nowrap><a class="el" href="group__osclbase.html#a109">TimeUnits</a> </td> 161 <td class="mdname" nowrap> <em>units</em></td> 162 </tr> 163 <tr> 164 <td></td> 165 <td class="md">) </td> 166 <td class="md" colspan="2"></td> 167 </tr> 168 169 </table> 170 </td> 171 </tr> 172 </table> 173 <table cellspacing=5 cellpadding=0 border=0> 174 <tr> 175 <td> 176 177 </td> 178 <td> 179 180 <p> 181 Create a TimeValue representing an interval of tv units. 182 <p> 183 <dl compact><dt><b>Parameters: </b></dt><dd> 184 <table border=0 cellspacing=2 cellpadding=0> 185 <tr><td valign=top><em>tv</em> </td><td> 186 The number of units in the interval to be represented by this TimeValue. </td></tr> 187 <tr><td valign=top><em>units</em> </td><td> 188 The units of the tv argument. Must be in the enumeration TimeUnits. </td></tr> 189 </table> 190 </dl> </td> 191 </tr> 192 </table> 193 <a name="a3" doxytag="TimeValue::TimeValue"></a><p> 194 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 195 <tr> 196 <td class="md"> 197 <table cellpadding="0" cellspacing="0" border="0"> 198 <tr> 199 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td> 200 <td class="md" valign="top">( </td> 201 <td class="md" nowrap valign="top">const <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a> & </td> 202 <td class="mdname1" valign="top" nowrap> <em>in_tv</em> </td> 203 <td class="md" valign="top">) </td> 204 <td class="md" nowrap></td> 205 </tr> 206 207 </table> 208 </td> 209 </tr> 210 </table> 211 <table cellspacing=5 cellpadding=0 border=0> 212 <tr> 213 <td> 214 215 </td> 216 <td> 217 218 <p> 219 Create a TimeValue representing the absolute time specified by the BasicTimeStruct. 220 <p> 221 <dl compact><dt><b>Parameters: </b></dt><dd> 222 <table border=0 cellspacing=2 cellpadding=0> 223 <tr><td valign=top><em>in_tv</em> </td><td> 224 OsclBasicTimeStruct as defined for each platform. </td></tr> 225 </table> 226 </dl> </td> 227 </tr> 228 </table> 229 <a name="a4" doxytag="TimeValue::TimeValue"></a><p> 230 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 231 <tr> 232 <td class="md"> 233 <table cellpadding="0" cellspacing="0" border="0"> 234 <tr> 235 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td> 236 <td class="md" valign="top">( </td> 237 <td class="md" nowrap valign="top"><a class="el" href="osclconfig__time_8h.html#a2">OsclBasicDateTimeStruct</a> </td> 238 <td class="mdname1" valign="top" nowrap> <em>in_ts</em> </td> 239 <td class="md" valign="top">) </td> 240 <td class="md" nowrap></td> 241 </tr> 242 243 </table> 244 </td> 245 </tr> 246 </table> 247 <table cellspacing=5 cellpadding=0 border=0> 248 <tr> 249 <td> 250 251 </td> 252 <td> 253 254 <p> 255 Create a TimeValue representing the absolute time specified by the BasicDateTimeStruct. 256 <p> 257 <dl compact><dt><b>Parameters: </b></dt><dd> 258 <table border=0 cellspacing=2 cellpadding=0> 259 <tr><td valign=top><em>in_ts</em> </td><td> 260 OsclBasicDateTimeStruct as defined for each platform provides the date in a readable format (i.e. day, date , week etc.) Notes: Implementation incomplete (= not done) on Win32, Wince, Symbian </td></tr> 261 </table> 262 </dl> </td> 263 </tr> 264 </table> 265 <hr><h2>Member Function Documentation</h2> 266 <a name="a5" doxytag="TimeValue::get_local_time"></a><p> 267 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 268 <tr> 269 <td class="md"> 270 <table cellpadding="0" cellspacing="0" border="0"> 271 <tr> 272 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF int32 TimeValue::get_local_time </td> 273 <td class="md" valign="top">( </td> 274 <td class="mdname1" valign="top" nowrap> </td> 275 <td class="md" valign="top">) </td> 276 <td class="md" nowrap></td> 277 </tr> 278 279 </table> 280 </td> 281 </tr> 282 </table> 283 <table cellspacing=5 cellpadding=0 border=0> 284 <tr> 285 <td> 286 287 </td> 288 <td> 289 290 <p> 291 Get the local time after having adjusted for daylight saving. 292 <p> 293 Notes: Implementation incomplete (= not done) on Win32, Wince, Symbian </td> 294 </tr> 295 </table> 296 <a name="a13" doxytag="TimeValue::get_pv8601_str_time"></a><p> 297 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 298 <tr> 299 <td class="md"> 300 <table cellpadding="0" cellspacing="0" border="0"> 301 <tr> 302 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int TimeValue::get_pv8601_str_time </td> 303 <td class="md" valign="top">( </td> 304 <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a> </td> 305 <td class="mdname1" valign="top" nowrap> <em>time_strbuf</em> </td> 306 <td class="md" valign="top">) </td> 307 <td class="md" nowrap></td> 308 </tr> 309 310 </table> 311 </td> 312 </tr> 313 </table> 314 <table cellspacing=5 cellpadding=0 border=0> 315 <tr> 316 <td> 317 318 </td> 319 <td> 320 321 <p> 322 Get a PV extended text representation of the Time based on the ISO 8601 format. 323 <p> 324 <dl compact><dt><b>Parameters: </b></dt><dd> 325 <table border=0 cellspacing=2 cellpadding=0> 326 <tr><td valign=top><em>time_strbuf</em> </td><td> 327 A PV8601timeStrBuf object to which the text representation will be written, </td></tr> 328 </table> 329 </dl><dl compact><dt><b>Returns: </b></dt><dd> 330 The number of characters copied to the buffer, not including the terminating null. The returned string is of the form "19850412T101530.047Z". </dl> </td> 331 </tr> 332 </table> 333 <a name="a14" doxytag="TimeValue::get_rfc822_gmtime_str"></a><p> 334 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 335 <tr> 336 <td class="md"> 337 <table cellpadding="0" cellspacing="0" border="0"> 338 <tr> 339 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF char* TimeValue::get_rfc822_gmtime_str </td> 340 <td class="md" valign="top">( </td> 341 <td class="md" nowrap valign="top">int </td> 342 <td class="mdname" nowrap> <em>max_time_strlen</em>, </td> 343 </tr> 344 <tr> 345 <td></td> 346 <td></td> 347 <td class="md" nowrap>char * </td> 348 <td class="mdname" nowrap> <em>time_str</em></td> 349 </tr> 350 <tr> 351 <td></td> 352 <td class="md">) </td> 353 <td class="md" colspan="2"></td> 354 </tr> 355 356 </table> 357 </td> 358 </tr> 359 </table> 360 <table cellspacing=5 cellpadding=0 border=0> 361 <tr> 362 <td> 363 364 </td> 365 <td> 366 367 <p> 368 Get a text representation of the time in the GMT timezone based on the RFC 822 / RFC 1123 (also described in the HTTP spec RFC 2068 and RFC 2616. 369 <p> 370 <dl compact><dt><b>Parameters: </b></dt><dd> 371 <table border=0 cellspacing=2 cellpadding=0> 372 <tr><td valign=top><em>max_time_strlen</em> </td><td> 373 The maximum number of characters that can be written to the buffer. </td></tr> 374 <tr><td valign=top><em>time_str</em> </td><td> 375 A pointer to the buffer to which the characters will be written. </td></tr> 376 </table> 377 </dl><dl compact><dt><b>Returns: </b></dt><dd> 378 Returns a pointer to the buffer (same as time_str) containing a null terminated (c-style) string of the form "Wed, 30 Jun 1993 21:49:08 GMT". </dl> </td> 379 </tr> 380 </table> 381 <a name="a9" doxytag="TimeValue::get_sec"></a><p> 382 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 383 <tr> 384 <td class="md"> 385 <table cellpadding="0" cellspacing="0" border="0"> 386 <tr> 387 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF uint32 TimeValue::get_sec </td> 388 <td class="md" valign="top">( </td> 389 <td class="mdname1" valign="top" nowrap> </td> 390 <td class="md" valign="top">) </td> 391 <td class="md" nowrap></td> 392 </tr> 393 394 </table> 395 </td> 396 </tr> 397 </table> 398 <table cellspacing=5 cellpadding=0 border=0> 399 <tr> 400 <td> 401 402 </td> 403 <td> 404 405 <p> 406 Get a 32 bit value representing the seconds since the (system dependent) epoch. 407 <p> 408 <dl compact><dt><b>Returns: </b></dt><dd> 409 This call returns a 32 bit value representing the nubmer of seconds since the epoch. On unix systems this represents the number of seconds since the unix epoch Jan 1 1970. On Win32 this represents the number of seconds since Jan 1, 1601. This is intended to be used for intervals rather than for absolute time. (On Win32 for example, a 32 bit value would be too small to represent the number of seconds from the epoch until the current time.) </dl> </td> 410 </tr> 411 </table> 412 <a name="a12" doxytag="TimeValue::get_str_ctime"></a><p> 413 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 414 <tr> 415 <td class="md"> 416 <table cellpadding="0" cellspacing="0" border="0"> 417 <tr> 418 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF char* TimeValue::get_str_ctime </td> 419 <td class="md" valign="top">( </td> 420 <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a> </td> 421 <td class="mdname1" valign="top" nowrap> <em>ctime_strbuf</em> </td> 422 <td class="md" valign="top">) </td> 423 <td class="md" nowrap></td> 424 </tr> 425 426 </table> 427 </td> 428 </tr> 429 </table> 430 <table cellspacing=5 cellpadding=0 border=0> 431 <tr> 432 <td> 433 434 </td> 435 <td> 436 437 <p> 438 Get a string containing a text representation of this TimeValue object. 439 <p> 440 <dl compact><dt><b>Parameters: </b></dt><dd> 441 <table border=0 cellspacing=2 cellpadding=0> 442 <tr><td valign=top><em>ctime_strbuf</em> </td><td> 443 A CtimeStrBuf object to which the text representation will be written, </td></tr> 444 </table> 445 </dl><dl compact><dt><b>Returns: </b></dt><dd> 446 A pointer to the input CtimeStrBuf is returned. This string is null terminated of the form "Wed Jun 30 21:49:08 1993". </dl> </td> 447 </tr> 448 </table> 449 <a name="a20" doxytag="TimeValue::get_timeval_ptr"></a><p> 450 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 451 <tr> 452 <td class="md"> 453 <table cellpadding="0" cellspacing="0" border="0"> 454 <tr> 455 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a>* TimeValue::get_timeval_ptr </td> 456 <td class="md" valign="top">( </td> 457 <td class="mdname1" valign="top" nowrap> </td> 458 <td class="md" valign="top">) </td> 459 <td class="md" nowrap></td> 460 </tr> 461 462 </table> 463 </td> 464 </tr> 465 </table> 466 <table cellspacing=5 cellpadding=0 border=0> 467 <tr> 468 <td> 469 470 </td> 471 <td> 472 473 <p> 474 </td> 475 </tr> 476 </table> 477 <a name="a11" doxytag="TimeValue::get_usec"></a><p> 478 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 479 <tr> 480 <td class="md"> 481 <table cellpadding="0" cellspacing="0" border="0"> 482 <tr> 483 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF uint32 TimeValue::get_usec </td> 484 <td class="md" valign="top">( </td> 485 <td class="mdname1" valign="top" nowrap> </td> 486 <td class="md" valign="top">) </td> 487 <td class="md" nowrap></td> 488 </tr> 489 490 </table> 491 </td> 492 </tr> 493 </table> 494 <table cellspacing=5 cellpadding=0 border=0> 495 <tr> 496 <td> 497 498 </td> 499 <td> 500 501 <p> 502 Get a 32 bit value representing the number of microseconds in the time value. 503 <p> 504 <dl compact><dt><b>Returns: </b></dt><dd> 505 Returns a uint32 value representing the number of microseconds in the time value after subtracting off the whole seconds. </dl> </td> 506 </tr> 507 </table> 508 <a name="a15" doxytag="TimeValue::is_zero"></a><p> 509 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 510 <tr> 511 <td class="md"> 512 <table cellpadding="0" cellspacing="0" border="0"> 513 <tr> 514 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF bool TimeValue::is_zero </td> 515 <td class="md" valign="top">( </td> 516 <td class="mdname1" valign="top" nowrap> </td> 517 <td class="md" valign="top">) </td> 518 <td class="md" nowrap></td> 519 </tr> 520 521 </table> 522 </td> 523 </tr> 524 </table> 525 <table cellspacing=5 cellpadding=0 border=0> 526 <tr> 527 <td> 528 529 </td> 530 <td> 531 532 <p> 533 Determine if the time value is zero. 534 <p> 535 </td> 536 </tr> 537 </table> 538 <a name="a19" doxytag="TimeValue::operator *="></a><p> 539 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 540 <tr> 541 <td class="md"> 542 <table cellpadding="0" cellspacing="0" border="0"> 543 <tr> 544 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue& TimeValue::operator *= </td> 545 <td class="md" valign="top">( </td> 546 <td class="md" nowrap valign="top">const int </td> 547 <td class="mdname1" valign="top" nowrap> <em>scale</em> </td> 548 <td class="md" valign="top">) </td> 549 <td class="md" nowrap></td> 550 </tr> 551 552 </table> 553 </td> 554 </tr> 555 </table> 556 <table cellspacing=5 cellpadding=0 border=0> 557 <tr> 558 <td> 559 560 </td> 561 <td> 562 563 <p> 564 This operator scales the time value by a constant. 565 <p> 566 </td> 567 </tr> 568 </table> 569 <a name="a17" doxytag="TimeValue::operator+="></a><p> 570 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 571 <tr> 572 <td class="md"> 573 <table cellpadding="0" cellspacing="0" border="0"> 574 <tr> 575 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue& TimeValue::operator+= </td> 576 <td class="md" valign="top">( </td> 577 <td class="md" nowrap valign="top">const TimeValue & </td> 578 <td class="mdname1" valign="top" nowrap> <em>a</em> </td> 579 <td class="md" valign="top">) </td> 580 <td class="md" nowrap></td> 581 </tr> 582 583 </table> 584 </td> 585 </tr> 586 </table> 587 <table cellspacing=5 cellpadding=0 border=0> 588 <tr> 589 <td> 590 591 </td> 592 <td> 593 594 <p> 595 += operator 596 <p> 597 </td> 598 </tr> 599 </table> 600 <a name="a18" doxytag="TimeValue::operator-="></a><p> 601 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 602 <tr> 603 <td class="md"> 604 <table cellpadding="0" cellspacing="0" border="0"> 605 <tr> 606 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue& TimeValue::operator-= </td> 607 <td class="md" valign="top">( </td> 608 <td class="md" nowrap valign="top">const TimeValue & </td> 609 <td class="mdname1" valign="top" nowrap> <em>a</em> </td> 610 <td class="md" valign="top">) </td> 611 <td class="md" nowrap></td> 612 </tr> 613 614 </table> 615 </td> 616 </tr> 617 </table> 618 <table cellspacing=5 cellpadding=0 border=0> 619 <tr> 620 <td> 621 622 </td> 623 <td> 624 625 <p> 626 -= operator 627 <p> 628 </td> 629 </tr> 630 </table> 631 <a name="a16" doxytag="TimeValue::operator="></a><p> 632 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 633 <tr> 634 <td class="md"> 635 <table cellpadding="0" cellspacing="0" border="0"> 636 <tr> 637 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue& TimeValue::operator= </td> 638 <td class="md" valign="top">( </td> 639 <td class="md" nowrap valign="top">const TimeValue & </td> 640 <td class="mdname1" valign="top" nowrap> <em>a</em> </td> 641 <td class="md" valign="top">) </td> 642 <td class="md" nowrap></td> 643 </tr> 644 645 </table> 646 </td> 647 </tr> 648 </table> 649 <table cellspacing=5 cellpadding=0 border=0> 650 <tr> 651 <td> 652 653 </td> 654 <td> 655 656 <p> 657 Assignment operator. 658 <p> 659 </td> 660 </tr> 661 </table> 662 <a name="a8" doxytag="TimeValue::set_from_ntp_time"></a><p> 663 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 664 <tr> 665 <td class="md"> 666 <table cellpadding="0" cellspacing="0" border="0"> 667 <tr> 668 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_from_ntp_time </td> 669 <td class="md" valign="top">( </td> 670 <td class="md" nowrap valign="top">const uint32 </td> 671 <td class="mdname1" valign="top" nowrap> <em>ntp_offset</em> </td> 672 <td class="md" valign="top">) </td> 673 <td class="md" nowrap></td> 674 </tr> 675 676 </table> 677 </td> 678 </tr> 679 </table> 680 <table cellspacing=5 cellpadding=0 border=0> 681 <tr> 682 <td> 683 684 </td> 685 <td> 686 687 <p> 688 This method coverts a 32-bit NTP offset to system time. 689 <p> 690 This method takes a 32-bit ntp offset which is the number of seconds from 0 h Jan 1, 1900 and converts it to the system time </td> 691 </tr> 692 </table> 693 <a name="a7" doxytag="TimeValue::set_to_current_time"></a><p> 694 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 695 <tr> 696 <td class="md"> 697 <table cellpadding="0" cellspacing="0" border="0"> 698 <tr> 699 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_to_current_time </td> 700 <td class="md" valign="top">( </td> 701 <td class="mdname1" valign="top" nowrap> </td> 702 <td class="md" valign="top">) </td> 703 <td class="md" nowrap></td> 704 </tr> 705 706 </table> 707 </td> 708 </tr> 709 </table> 710 <table cellspacing=5 cellpadding=0 border=0> 711 <tr> 712 <td> 713 714 </td> 715 <td> 716 717 <p> 718 Set the time value to the current system time. 719 <p> 720 </td> 721 </tr> 722 </table> 723 <a name="a6" doxytag="TimeValue::set_to_zero"></a><p> 724 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 725 <tr> 726 <td class="md"> 727 <table cellpadding="0" cellspacing="0" border="0"> 728 <tr> 729 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_to_zero </td> 730 <td class="md" valign="top">( </td> 731 <td class="mdname1" valign="top" nowrap> </td> 732 <td class="md" valign="top">) </td> 733 <td class="md" nowrap></td> 734 </tr> 735 736 </table> 737 </td> 738 </tr> 739 </table> 740 <table cellspacing=5 cellpadding=0 border=0> 741 <tr> 742 <td> 743 744 </td> 745 <td> 746 747 <p> 748 Set the time value to zero (represents a zero interval). 749 <p> 750 </td> 751 </tr> 752 </table> 753 <a name="a10" doxytag="TimeValue::to_msec"></a><p> 754 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 755 <tr> 756 <td class="md"> 757 <table cellpadding="0" cellspacing="0" border="0"> 758 <tr> 759 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF int32 TimeValue::to_msec </td> 760 <td class="md" valign="top">( </td> 761 <td class="mdname1" valign="top" nowrap> </td> 762 <td class="md" valign="top">) </td> 763 <td class="md" nowrap></td> 764 </tr> 765 766 </table> 767 </td> 768 </tr> 769 </table> 770 <table cellspacing=5 cellpadding=0 border=0> 771 <tr> 772 <td> 773 774 </td> 775 <td> 776 777 <p> 778 </td> 779 </tr> 780 </table> 781 <hr><h2>Friends And Related Function Documentation</h2> 782 <a name="l0" doxytag="TimeValue::NTPTime"></a><p> 783 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 784 <tr> 785 <td class="md"> 786 <table cellpadding="0" cellspacing="0" border="0"> 787 <tr> 788 <td class="md" nowrap valign="top"> friend class NTPTime<code> [friend]</code> 789 </table> 790 </td> 791 </tr> 792 </table> 793 <table cellspacing=5 cellpadding=0 border=0> 794 <tr> 795 <td> 796 797 </td> 798 <td> 799 800 <p> 801 </td> 802 </tr> 803 </table> 804 <a name="l2" doxytag="TimeValue::operator!="></a><p> 805 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 806 <tr> 807 <td class="md"> 808 <table cellpadding="0" cellspacing="0" border="0"> 809 <tr> 810 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator!= </td> 811 <td class="md" valign="top">( </td> 812 <td class="md" nowrap valign="top">const TimeValue & </td> 813 <td class="mdname" nowrap> <em>a</em>, </td> 814 </tr> 815 <tr> 816 <td></td> 817 <td></td> 818 <td class="md" nowrap>const TimeValue & </td> 819 <td class="mdname" nowrap> <em>b</em></td> 820 </tr> 821 <tr> 822 <td></td> 823 <td class="md">) </td> 824 <td class="md" colspan="2"><code> [friend]</code></td> 825 </tr> 826 827 </table> 828 </td> 829 </tr> 830 </table> 831 <table cellspacing=5 cellpadding=0 border=0> 832 <tr> 833 <td> 834 835 </td> 836 <td> 837 838 <p> 839 </td> 840 </tr> 841 </table> 842 <a name="l5" doxytag="TimeValue::operator<"></a><p> 843 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 844 <tr> 845 <td class="md"> 846 <table cellpadding="0" cellspacing="0" border="0"> 847 <tr> 848 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator< </td> 849 <td class="md" valign="top">( </td> 850 <td class="md" nowrap valign="top">const TimeValue & </td> 851 <td class="mdname" nowrap> <em>a</em>, </td> 852 </tr> 853 <tr> 854 <td></td> 855 <td></td> 856 <td class="md" nowrap>const TimeValue & </td> 857 <td class="mdname" nowrap> <em>b</em></td> 858 </tr> 859 <tr> 860 <td></td> 861 <td class="md">) </td> 862 <td class="md" colspan="2"><code> [friend]</code></td> 863 </tr> 864 865 </table> 866 </td> 867 </tr> 868 </table> 869 <table cellspacing=5 cellpadding=0 border=0> 870 <tr> 871 <td> 872 873 </td> 874 <td> 875 876 <p> 877 </td> 878 </tr> 879 </table> 880 <a name="l3" doxytag="TimeValue::operator<="></a><p> 881 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 882 <tr> 883 <td class="md"> 884 <table cellpadding="0" cellspacing="0" border="0"> 885 <tr> 886 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator<= </td> 887 <td class="md" valign="top">( </td> 888 <td class="md" nowrap valign="top">const TimeValue & </td> 889 <td class="mdname" nowrap> <em>a</em>, </td> 890 </tr> 891 <tr> 892 <td></td> 893 <td></td> 894 <td class="md" nowrap>const TimeValue & </td> 895 <td class="mdname" nowrap> <em>b</em></td> 896 </tr> 897 <tr> 898 <td></td> 899 <td class="md">) </td> 900 <td class="md" colspan="2"><code> [friend]</code></td> 901 </tr> 902 903 </table> 904 </td> 905 </tr> 906 </table> 907 <table cellspacing=5 cellpadding=0 border=0> 908 <tr> 909 <td> 910 911 </td> 912 <td> 913 914 <p> 915 </td> 916 </tr> 917 </table> 918 <a name="l1" doxytag="TimeValue::operator=="></a><p> 919 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 920 <tr> 921 <td class="md"> 922 <table cellpadding="0" cellspacing="0" border="0"> 923 <tr> 924 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator== </td> 925 <td class="md" valign="top">( </td> 926 <td class="md" nowrap valign="top">const TimeValue & </td> 927 <td class="mdname" nowrap> <em>a</em>, </td> 928 </tr> 929 <tr> 930 <td></td> 931 <td></td> 932 <td class="md" nowrap>const TimeValue & </td> 933 <td class="mdname" nowrap> <em>b</em></td> 934 </tr> 935 <tr> 936 <td></td> 937 <td class="md">) </td> 938 <td class="md" colspan="2"><code> [friend]</code></td> 939 </tr> 940 941 </table> 942 </td> 943 </tr> 944 </table> 945 <table cellspacing=5 cellpadding=0 border=0> 946 <tr> 947 <td> 948 949 </td> 950 <td> 951 952 <p> 953 </td> 954 </tr> 955 </table> 956 <a name="l6" doxytag="TimeValue::operator>"></a><p> 957 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 958 <tr> 959 <td class="md"> 960 <table cellpadding="0" cellspacing="0" border="0"> 961 <tr> 962 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator> </td> 963 <td class="md" valign="top">( </td> 964 <td class="md" nowrap valign="top">const TimeValue & </td> 965 <td class="mdname" nowrap> <em>a</em>, </td> 966 </tr> 967 <tr> 968 <td></td> 969 <td></td> 970 <td class="md" nowrap>const TimeValue & </td> 971 <td class="mdname" nowrap> <em>b</em></td> 972 </tr> 973 <tr> 974 <td></td> 975 <td class="md">) </td> 976 <td class="md" colspan="2"><code> [friend]</code></td> 977 </tr> 978 979 </table> 980 </td> 981 </tr> 982 </table> 983 <table cellspacing=5 cellpadding=0 border=0> 984 <tr> 985 <td> 986 987 </td> 988 <td> 989 990 <p> 991 </td> 992 </tr> 993 </table> 994 <a name="l4" doxytag="TimeValue::operator>="></a><p> 995 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 996 <tr> 997 <td class="md"> 998 <table cellpadding="0" cellspacing="0" border="0"> 999 <tr> 1000 <td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator>= </td> 1001 <td class="md" valign="top">( </td> 1002 <td class="md" nowrap valign="top">const TimeValue & </td> 1003 <td class="mdname" nowrap> <em>a</em>, </td> 1004 </tr> 1005 <tr> 1006 <td></td> 1007 <td></td> 1008 <td class="md" nowrap>const TimeValue & </td> 1009 <td class="mdname" nowrap> <em>b</em></td> 1010 </tr> 1011 <tr> 1012 <td></td> 1013 <td class="md">) </td> 1014 <td class="md" colspan="2"><code> [friend]</code></td> 1015 </tr> 1016 1017 </table> 1018 </td> 1019 </tr> 1020 </table> 1021 <table cellspacing=5 cellpadding=0 border=0> 1022 <tr> 1023 <td> 1024 1025 </td> 1026 <td> 1027 1028 <p> 1029 </td> 1030 </tr> 1031 </table> 1032 <hr>The documentation for this class was generated from the following file:<ul> 1033 <li><a class="el" href="oscl__time_8h-source.html">oscl_time.h</a></ul> 1034 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 1035 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 1036 </small></address> 1037 </body> 1038 </html> 1039
