<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: ucommon::DateTimeString Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00044.html">DateTimeString</a>
</div>
</div>
<div class="contents">
<h1>ucommon::DateTimeString Class Reference</h1><!-- doxytag: class="ucommon::DateTimeString" --><!-- doxytag: inherits="ucommon::DateTime" -->
<p>A <a class="el" href="a00043.html" title="The Datetime class uses a julian date representation of the current year, month,...">DateTime</a> string class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00183_source.html">datetime.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::DateTimeString:</div>
<div class="dynsection">
<div class="center"><img src="a00373.png" border="0" usemap="#ucommon_1_1_date_time_string_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_date_time_string_inherit__map" id="ucommon_1_1_date_time_string_inherit__map">
<area shape="rect" id="node2" href="a00043.html" title="The Datetime class uses a julian date representation of the current year, month,..." alt="" coords="73,80,265,107"/><area shape="rect" id="node4" href="a00041.html" title="The Date class uses a julian date representation of the current year, month, and..." alt="" coords="5,5,157,32"/><area shape="rect" id="node6" href="a00160.html" title="The Time class uses a integer representation of the current time." alt="" coords="181,5,333,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::DateTimeString:</div>
<div class="dynsection">
<div class="center"><img src="a00374.png" border="0" usemap="#ucommon_1_1_date_time_string_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_date_time_string_coll__map" id="ucommon_1_1_date_time_string_coll__map">
<area shape="rect" id="node2" href="a00043.html" title="The Datetime class uses a julian date representation of the current year, month,..." alt="" coords="73,80,265,107"/><area shape="rect" id="node4" href="a00041.html" title="The Date class uses a julian date representation of the current year, month, and..." alt="" coords="5,5,157,32"/><area shape="rect" id="node6" href="a00160.html" title="The Time class uses a integer representation of the current time." alt="" coords="181,5,333,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">mode_t</a> { <b>DATE</b>,
<b>TIME</b>,
<b>BOTH</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Specify string buffer mode. </p>
<a href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a6545fb1ea0d5ec1078b86f0cdc541c00">c_str</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract char from string. <a href="#a6545fb1ea0d5ec1078b86f0cdc541c00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44bcde9e718bd6a35c3aba36a628c19d"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="a44bcde9e718bd6a35c3aba36a628c19d" args="(mode_t string=DateTimeString::BOTH)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a44bcde9e718bd6a35c3aba36a628c19d">DateTimeString</a> (<a class="el" href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">mode_t</a> <a class="el" href="a00148.html">string</a>=DateTimeString::BOTH)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new date and time object with current date and time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#aa1aff44cc7b800bb3428cbf51f5ce260">DateTimeString</a> (const <a class="el" href="a00044.html">DateTimeString</a> &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a datetime object from another object. <a href="#aa1aff44cc7b800bb3428cbf51f5ce260"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#aaefb81f72a51a8b80b3aa842f8a7e7f3">DateTimeString</a> (int year, unsigned month, unsigned day, int hour=0, int minute=0, int second=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a date and time object from explicit date and time values. <a href="#aaefb81f72a51a8b80b3aa842f8a7e7f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a0365569e3340ccf3bbdd8aa6f0851532">DateTimeString</a> (const char *<a class="el" href="a00110.html">pointer</a>, size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a date and time from ISO string buffer. <a href="#a0365569e3340ccf3bbdd8aa6f0851532"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a131726565ca53f14eb91eac6cb97769d">DateTimeString</a> (<a class="el" href="a00183.html#a2fea857c30e2c901566fcf45fac68ac5">tm_t</a> *tm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a date and time from C library time structure. <a href="#a131726565ca53f14eb91eac6cb97769d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a3c4a1e9747db39f2308e54daa75a2daa">DateTimeString</a> (time_t time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a date and time from C libraray time_t type. <a href="#a3c4a1e9747db39f2308e54daa75a2daa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a6803dd6c4f923af9ba3b84d898464a83">operator const char *</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast to string. <a href="#a6803dd6c4f923af9ba3b84d898464a83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a834574250db9baba5fac73dfa952dc33">set</a> (<a class="el" href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">mode_t</a> <a class="el" href="a00148.html">string</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the string mode. <a href="#a834574250db9baba5fac73dfa952dc33"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a238bd33103212d4a65ad90c4a679cfb4"></a><!-- doxytag: member="ucommon::DateTimeString::set" ref="a238bd33103212d4a65ad90c4a679cfb4" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a238bd33103212d4a65ad90c4a679cfb4">set</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set (update) the date and time with current date and time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a095174984f5a5feb91a1df0109144832"></a><!-- doxytag: member="ucommon::DateTimeString::~DateTimeString" ref="a095174984f5a5feb91a1df0109144832" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a095174984f5a5feb91a1df0109144832">~DateTimeString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy date time string. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a7a5a1b653d23853e8018345cdaca129b">update</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method to use to "post" any changed values when shadowing a mixed object class. <a href="#a7a5a1b653d23853e8018345cdaca129b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="a00043.html" title="The Datetime class uses a julian date representation of the current year, month,...">DateTime</a> string class. </p>
<p>This can be used to access the date and time as a standard string without requiring an external buffer.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> a datetime class that returns strings. </dd></dl>
<p>Definition at line <a class="el" href="a00183_source.html#l00899">899</a> of file <a class="el" href="a00183_source.html">datetime.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a2a21e0ac3f4a609a0003a40f39b24fa2"></a><!-- doxytag: member="ucommon::DateTimeString::mode_t" ref="a2a21e0ac3f4a609a0003a40f39b24fa2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">ucommon::DateTimeString::mode_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify string buffer mode. </p>
<p>By default we form a string with date and time. </p>
<p>Definition at line <a class="el" href="a00183_source.html#l00906">906</a> of file <a class="el" href="a00183_source.html">datetime.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3c4a1e9747db39f2308e54daa75a2daa"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="a3c4a1e9747db39f2308e54daa75a2daa" args="(time_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>time</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a date and time from C libraray time_t type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>type to make date and time from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a131726565ca53f14eb91eac6cb97769d"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="a131726565ca53f14eb91eac6cb97769d" args="(tm_t *tm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00183.html#a2fea857c30e2c901566fcf45fac68ac5">tm_t</a> * </td>
<td class="paramname"> <em>tm</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a date and time from C library time structure. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tm</em> </td><td>structure from C library (from glt or gmt). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0365569e3340ccf3bbdd8aa6f0851532"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="a0365569e3340ccf3bbdd8aa6f0851532" args="(const char *pointer, size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pointer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a date and time from ISO string buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>to string field holding date and time. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of field if not null terminated string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaefb81f72a51a8b80b3aa842f8a7e7f3"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="aaefb81f72a51a8b80b3aa842f8a7e7f3" args="(int year, unsigned month, unsigned day, int hour=0, int minute=0, int second=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>year</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>month</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>day</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>hour</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>minute</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>second</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a date and time object from explicit date and time values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>year</em> </td><td>of object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>month</em> </td><td>of object (1-12). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>day</em> </td><td>of month of object (1-31). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hour</em> </td><td>of object (0-23). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>minute</em> </td><td>of object (0-59). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>second</em> </td><td>of object (0-59). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa1aff44cc7b800bb3428cbf51f5ce260"></a><!-- doxytag: member="ucommon::DateTimeString::DateTimeString" ref="aa1aff44cc7b800bb3428cbf51f5ce260" args="(const DateTimeString &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00044.html">DateTimeString</a> & </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a datetime object from another object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6545fb1ea0d5ec1078b86f0cdc541c00"></a><!-- doxytag: member="ucommon::DateTimeString::c_str" ref="a6545fb1ea0d5ec1078b86f0cdc541c00" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucommon::DateTimeString::c_str </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract char from string. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string of datetime. </dd></dl>
<p>Definition at line <a class="el" href="a00183_source.html#l00969">969</a> of file <a class="el" href="a00183_source.html">datetime.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6803dd6c4f923af9ba3b84d898464a83"></a><!-- doxytag: member="ucommon::DateTimeString::operator const char *" ref="a6803dd6c4f923af9ba3b84d898464a83" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::DateTimeString::operator const char * </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast to string. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string of datetime. </dd></dl>
<p>Definition at line <a class="el" href="a00183_source.html#l00977">977</a> of file <a class="el" href="a00183_source.html">datetime.h</a>.</p>
</div>
</div>
<a class="anchor" id="a834574250db9baba5fac73dfa952dc33"></a><!-- doxytag: member="ucommon::DateTimeString::set" ref="a834574250db9baba5fac73dfa952dc33" args="(mode_t string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::DateTimeString::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00044.html#a2a21e0ac3f4a609a0003a40f39b24fa2">mode_t</a> </td>
<td class="paramname"> <em>string</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the string mode. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>mode to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7a5a1b653d23853e8018345cdaca129b"></a><!-- doxytag: member="ucommon::DateTimeString::update" ref="a7a5a1b653d23853e8018345cdaca129b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::DateTimeString::update </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A method to use to "post" any changed values when shadowing a mixed object class. </p>
<p>This is used by <a class="el" href="a00042.html" title="A number class that manipulates a string buffer that is also a date.">DateNumber</a> and string classes. </p>
<p>Reimplemented from <a class="el" href="a00043.html#ae7d5caa6ed28499072343478538e3f06">ucommon::DateTime</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00183_source.html">datetime.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:34 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
