Google Git
Sign in
android / platform / external / opencore / refs/tags/android-1.6_r1.2 / . / doc / oscl_html / classTimeValue.html
blob: b15bea62864943b113f53c771b9542da9d418027 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TimeValue class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>TimeValue Class Reference<br>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1>The TimeValue class represents a time value in a format native to the system.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="oscl__time_8h-source.html">oscl_time.h</a>&gt;</code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a0">TimeValue</a> ()</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a1">TimeValue</a> (const TimeValue &amp;Tv)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Copy constructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF&nbsp;</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>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF&nbsp;</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> &amp;in_tv)</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF&nbsp;</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>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a5">get_local_time</a> ()</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a6">set_to_zero</a> ()</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a7">set_to_current_time</a> ()</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a8">set_from_ntp_time</a> (const uint32 ntp_offset)</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF uint32&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a9">get_sec</a> () const</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a10">to_msec</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF uint32&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a11">get_usec</a> () const</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF char *&nbsp;</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>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int&nbsp;</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>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF char *&nbsp;</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>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a15">is_zero</a> ()</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue &amp;&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a16">operator=</a> (const TimeValue &amp;a)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Assignment operator.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue &amp;&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a17">operator+=</a> (const TimeValue &amp;a)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>+= operator</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue &amp;&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a18">operator-=</a> (const TimeValue &amp;a)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>-= operator</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF TimeValue &amp;&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a19">operator *=</a> (const int scale)</td></tr>
<tr><td>&nbsp;</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>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a> *&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#a20">get_timeval_ptr</a> ()</td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l0">NTPTime</a></td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l1">operator==</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l2">operator!=</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l3">operator&lt;=</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l4">operator&gt;=</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l5">operator&lt;</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF friend <br>
bool&nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html#l6">operator&gt;</a> (const TimeValue &amp;a, const TimeValue &amp;b)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The TimeValue class represents a time value in a format native to the system.
<p>
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>
<li>OSCL_HAS_ANSI_STRING_SUPPORT:</ul>
Definitions to determine the type of basic time structure used to store the time<ul>
<li>OSCL_HAS_UNIX_TIME_FUNCS<li>OSCL_HAS_SYMBIAN_SUPPORT<li>OSCL_HAS_MSWIN_SUPPORT </ul>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="TimeValue::TimeValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create a TimeValue representing the current time.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="TimeValue::TimeValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>Tv</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Copy constructor.
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="TimeValue::TimeValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>tv</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__osclbase.html#a109">TimeUnits</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>units</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create a TimeValue representing an interval of tv units.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>tv</em>&nbsp;</td><td>
The number of units in the interval to be represented by this TimeValue. </td></tr>
<tr><td valign=top><em>units</em>&nbsp;</td><td>
The units of the tv argument. Must be in the enumeration TimeUnits. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="TimeValue::TimeValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="osclconfig__time_8h.html#a1">OsclBasicTimeStruct</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>in_tv</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create a TimeValue representing the absolute time specified by the BasicTimeStruct.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>in_tv</em>&nbsp;</td><td>
OsclBasicTimeStruct as defined for each platform. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="TimeValue::TimeValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue::TimeValue </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="osclconfig__time_8h.html#a2">OsclBasicDateTimeStruct</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>in_ts</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create a TimeValue representing the absolute time specified by the BasicDateTimeStruct.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>in_ts</em>&nbsp;</td><td>
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>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="TimeValue::get_local_time"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF int32 TimeValue::get_local_time </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the local time after having adjusted for daylight saving.
<p>
Notes: Implementation incomplete (= not done) on Win32, Wince, Symbian </td>
</tr>
</table>
<a name="a13" doxytag="TimeValue::get_pv8601_str_time"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF int TimeValue::get_pv8601_str_time </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>time_strbuf</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a PV extended text representation of the Time based on the ISO 8601 format.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>time_strbuf</em>&nbsp;</td><td>
A PV8601timeStrBuf object to which the text representation will be written, </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
The number of characters copied to the buffer, not including the terminating null. The returned string is of the form "19850412T101530.047Z". </dl> </td>
</tr>
</table>
<a name="a14" doxytag="TimeValue::get_rfc822_gmtime_str"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF char* TimeValue::get_rfc822_gmtime_str </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>max_time_strlen</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>time_str</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>max_time_strlen</em>&nbsp;</td><td>
The maximum number of characters that can be written to the buffer. </td></tr>
<tr><td valign=top><em>time_str</em>&nbsp;</td><td>
A pointer to the buffer to which the characters will be written. </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
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>
</tr>
</table>
<a name="a9" doxytag="TimeValue::get_sec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF uint32 TimeValue::get_sec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a 32 bit value representing the seconds since the (system dependent) epoch.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
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>
</tr>
</table>
<a name="a12" doxytag="TimeValue::get_str_ctime"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF char* TimeValue::get_str_ctime </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>ctime_strbuf</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a string containing a text representation of this TimeValue object.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ctime_strbuf</em>&nbsp;</td><td>
A CtimeStrBuf object to which the text representation will be written, </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
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>
</tr>
</table>
<a name="a20" doxytag="TimeValue::get_timeval_ptr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="TimeValue::get_usec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF uint32 TimeValue::get_usec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a 32 bit value representing the number of microseconds in the time value.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns a uint32 value representing the number of microseconds in the time value after subtracting off the whole seconds. </dl> </td>
</tr>
</table>
<a name="a15" doxytag="TimeValue::is_zero"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF bool TimeValue::is_zero </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Determine if the time value is zero.
<p>
</td>
</tr>
</table>
<a name="a19" doxytag="TimeValue::operator *="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue&amp; TimeValue::operator *= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>scale</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This operator scales the time value by a constant.
<p>
</td>
</tr>
</table>
<a name="a17" doxytag="TimeValue::operator+="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue&amp; TimeValue::operator+= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
+= operator
<p>
</td>
</tr>
</table>
<a name="a18" doxytag="TimeValue::operator-="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue&amp; TimeValue::operator-= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
-= operator
<p>
</td>
</tr>
</table>
<a name="a16" doxytag="TimeValue::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF TimeValue&amp; TimeValue::operator= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Assignment operator.
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="TimeValue::set_from_ntp_time"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_from_ntp_time </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>ntp_offset</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This method coverts a 32-bit NTP offset to system time.
<p>
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>
</tr>
</table>
<a name="a7" doxytag="TimeValue::set_to_current_time"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_to_current_time </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the time value to the current system time.
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="TimeValue::set_to_zero"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF void TimeValue::set_to_zero </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the time value to zero (represents a zero interval).
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="TimeValue::to_msec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF int32 TimeValue::to_msec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l0" doxytag="TimeValue::NTPTime"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> friend class NTPTime<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l2" doxytag="TimeValue::operator!="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator!= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l5" doxytag="TimeValue::operator<"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator&lt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l3" doxytag="TimeValue::operator<="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator&lt;= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l1" doxytag="TimeValue::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator== </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l6" doxytag="TimeValue::operator>"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator&gt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l4" doxytag="TimeValue::operator>="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_COND_IMPORT_REF friend bool operator&gt;= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TimeValue &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__time_8h-source.html">oscl_time.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>