<!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: DateTimeString Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00042.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>DateTimeString Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="DateTimeString" --><!-- doxytag: inherits="DateTime" -->
<p>A <a class="el" href="a00041.html" title="The Datetime class uses a julian date representation of the current year, month, and day and a intege...">DateTime</a> string class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00182_source.html">datetime.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for DateTimeString:</div>
<div class="dyncontent">
<div class="center"><img src="a00306.png" border="0" usemap="#_date_time_string_inherit__map" alt="Inheritance graph"/></div>
<map name="_date_time_string_inherit__map" id="_date_time_string_inherit__map">
<area shape="rect" id="node2" href="a00041.html" title="The Datetime class uses a julian date representation of the current year, month, and day and a intege..." alt="" coords="36,80,137,107"/><area shape="rect" id="node4" href="a00039.html" title="The Date class uses a julian date representation of the current year, month, and day." alt="" coords="13,5,75,32"/><area shape="rect" id="node6" href="a00159.html" title="The Time class uses a integer representation of the current time." alt="" coords="99,5,160,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for DateTimeString:</div>
<div class="dyncontent">
<div class="center"><img src="a00307.png" border="0" usemap="#_date_time_string_coll__map" alt="Collaboration graph"/></div>
<map name="_date_time_string_coll__map" id="_date_time_string_coll__map">
<area shape="rect" id="node2" href="a00041.html" title="The Datetime class uses a julian date representation of the current year, month, and day and a intege..." alt="" coords="36,80,137,107"/><area shape="rect" id="node4" href="a00039.html" title="The Date class uses a julian date representation of the current year, month, and day." alt="" coords="13,5,75,32"/><area shape="rect" id="node6" href="a00159.html" title="The Time class uses a integer representation of the current time." alt="" coords="99,5,160,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">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="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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="a00042.html#a0bddd6eee947644bb280c1897c4824e9">c_str</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract char from string. <a href="#a0bddd6eee947644bb280c1897c4824e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a68912a47d5bcd3f97f558dcda3ba246a">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="#a68912a47d5bcd3f97f558dcda3ba246a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#ada202ebd69f514b956433e2930710d60">DateTimeString</a> (<a class="el" href="a00182.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="#ada202ebd69f514b956433e2930710d60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#ad0cae6eef695ce51a647c3bf23ce1efc">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="#ad0cae6eef695ce51a647c3bf23ce1efc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a98d6d72f423a8da5780ba383b012e640">DateTimeString</a> (const <a class="el" href="a00042.html">DateTimeString</a> &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a datetime object from another object. <a href="#a98d6d72f423a8da5780ba383b012e640"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a602b3c2a83695181d3f0435a6af692d9">DateTimeString</a> (const char *<a class="el" href="a00108.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="#a602b3c2a83695181d3f0435a6af692d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac24df699c560742f46d08649f48329bc"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="ac24df699c560742f46d08649f48329bc" args="(mode_t string=DateTimeString::BOTH)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#ac24df699c560742f46d08649f48329bc">DateTimeString</a> (<a class="el" href="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">mode_t</a> <a class="el" href="a00150.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="a00042.html#a7df4d533df2018dabb9802d2949e652b">operator const char *</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast to string. <a href="#a7df4d533df2018dabb9802d2949e652b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a83c7e1836fe35cda1010bcae816199ee">set</a> (<a class="el" href="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">mode_t</a> <a class="el" href="a00150.html">string</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the string mode. <a href="#a83c7e1836fe35cda1010bcae816199ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a7cb8bb918827ff78eb2a3948b092e6"></a><!-- doxytag: member="DateTimeString::set" ref="a9a7cb8bb918827ff78eb2a3948b092e6" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a9a7cb8bb918827ff78eb2a3948b092e6">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="adcb5af4a0c2264e85cdc94786bc3bc7c"></a><!-- doxytag: member="DateTimeString::~DateTimeString" ref="adcb5af4a0c2264e85cdc94786bc3bc7c" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#adcb5af4a0c2264e85cdc94786bc3bc7c">~DateTimeString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy date time string. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
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="a00042.html#a03860a3c2841083d8193341ee1690e02">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="#a03860a3c2841083d8193341ee1690e02"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="a00041.html" title="The Datetime class uses a julian date representation of the current year, month, and day and a intege...">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>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="a00001.html#_a6">datetime.cpp</a>.</p>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00182_source.html#l00899">899</a> of file <a class="el" href="a00182_source.html">datetime.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aa19b76e8ccc0e2e20b6a654f26ae948e"></a><!-- doxytag: member="DateTimeString::mode_t" ref="aa19b76e8ccc0e2e20b6a654f26ae948e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">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="a00182_source.html#l00906">906</a> of file <a class="el" href="a00182_source.html">datetime.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a68912a47d5bcd3f97f558dcda3ba246a"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="a68912a47d5bcd3f97f558dcda3ba246a" args="(time_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="params">
<tr><td class="paramname">time</td><td>type to make date and time from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ada202ebd69f514b956433e2930710d60"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="ada202ebd69f514b956433e2930710d60" args="(tm_t *tm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00182.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 class="params">
<tr><td class="paramname">tm</td><td>structure from C library (from glt or gmt). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a602b3c2a83695181d3f0435a6af692d9"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="a602b3c2a83695181d3f0435a6af692d9" args="(const char *pointer, size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">pointer</td><td>to string field holding date and time. </td></tr>
<tr><td class="paramname">size</td><td>of field if not null terminated string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad0cae6eef695ce51a647c3bf23ce1efc"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="ad0cae6eef695ce51a647c3bf23ce1efc" 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">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>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">year</td><td>of object. </td></tr>
<tr><td class="paramname">month</td><td>of object (1-12). </td></tr>
<tr><td class="paramname">day</td><td>of month of object (1-31). </td></tr>
<tr><td class="paramname">hour</td><td>of object (0-23). </td></tr>
<tr><td class="paramname">minute</td><td>of object (0-59). </td></tr>
<tr><td class="paramname">second</td><td>of object (0-59). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a98d6d72f423a8da5780ba383b012e640"></a><!-- doxytag: member="DateTimeString::DateTimeString" ref="a98d6d72f423a8da5780ba383b012e640" args="(const DateTimeString &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DateTimeString::DateTimeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00042.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 class="params">
<tr><td class="paramname">object</td><td>to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0bddd6eee947644bb280c1897c4824e9"></a><!-- doxytag: member="DateTimeString::c_str" ref="a0bddd6eee947644bb280c1897c4824e9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* 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="a00182_source.html#l00969">969</a> of file <a class="el" href="a00182_source.html">datetime.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7df4d533df2018dabb9802d2949e652b"></a><!-- doxytag: member="DateTimeString::operator const char *" ref="a7df4d533df2018dabb9802d2949e652b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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="a00182_source.html#l00977">977</a> of file <a class="el" href="a00182_source.html">datetime.h</a>.</p>
</div>
</div>
<a class="anchor" id="a83c7e1836fe35cda1010bcae816199ee"></a><!-- doxytag: member="DateTimeString::set" ref="a83c7e1836fe35cda1010bcae816199ee" args="(mode_t string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateTimeString::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00042.html#aa19b76e8ccc0e2e20b6a654f26ae948e">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 class="params">
<tr><td class="paramname">string</td><td>mode to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a03860a3c2841083d8193341ee1690e02"></a><!-- doxytag: member="DateTimeString::update" ref="a03860a3c2841083d8193341ee1690e02" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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="a00040.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="a00041.html#aac4abdfd8cba6743ff951e882b0ae67c">DateTime</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00182_source.html">datetime.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00042.html">DateTimeString</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
