<!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>Wt: Wt::WTime Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Wt  <span id="projectnumber">3.2.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li> <li class="navelem"><a class="el" href="classWt_1_1WTime.html">WTime</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::WTime Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::WTime" --> <p>A value class that defines a clock time. <a href="classWt_1_1WTime.html#details">More...</a></p> <p><code>#include <Wt/WTime></code></p> <p><a href="classWt_1_1WTime-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#af45b86652752e63c00baee8662d793e3">WTime</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <em>Null</em> time. <a href="#af45b86652752e63c00baee8662d793e3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a529d211c58a37ad4568745414c4a25c8">WTime</a> (int h, int m, int s=0, int ms=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a time given hour, minutes, seconds, and milliseconds. <a href="#a529d211c58a37ad4568745414c4a25c8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ae506c60945d8c2a452233ade046fa9ac">setHMS</a> (int h, int m, int s, int ms=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time. <a href="#ae506c60945d8c2a452233ade046fa9ac"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WTime.html">WTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a2779ca22acb1f51ad93320956501b251">addSecs</a> (int s) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds seconds. <a href="#a2779ca22acb1f51ad93320956501b251"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WTime.html">WTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a534f180014e634562dc808bc1e36e215">addMSecs</a> (int ms) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds milliseconds. <a href="#a534f180014e634562dc808bc1e36e215"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#acfff1a1b2a4c38af39649491c15d516e">isNull</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if this time is <em>Null</em>. <a href="#acfff1a1b2a4c38af39649491c15d516e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8e2713bf2844daeaf97820224a941ac"></a><!-- doxytag: member="Wt::WTime::isValid" ref="aa8e2713bf2844daeaf97820224a941ac" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac">isValid</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if this time is valid. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c7b13602f9da6c8f962ab732ece2c37"></a><!-- doxytag: member="Wt::WTime::hour" ref="a2c7b13602f9da6c8f962ab732ece2c37" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a2c7b13602f9da6c8f962ab732ece2c37">hour</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the hour (0-23). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9d6e852ce86333537bef1fc133d7942"></a><!-- doxytag: member="Wt::WTime::minute" ref="ae9d6e852ce86333537bef1fc133d7942" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ae9d6e852ce86333537bef1fc133d7942">minute</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the minutes (0-59). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae009d5f15e86a6976cb2519efa3bdfee"></a><!-- doxytag: member="Wt::WTime::second" ref="ae009d5f15e86a6976cb2519efa3bdfee" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ae009d5f15e86a6976cb2519efa3bdfee">second</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the seconds (0-59). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9eb15777053a11ed7212a44978f07f0f"></a><!-- doxytag: member="Wt::WTime::msec" ref="a9eb15777053a11ed7212a44978f07f0f" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a9eb15777053a11ed7212a44978f07f0f">msec</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the milliseconds (0-999) <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a53bc25995b5c3cd1bcffd2e0d562e08d">secsTo</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &t) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the difference between two time values (in seconds). <a href="#a53bc25995b5c3cd1bcffd2e0d562e08d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a425254ca9b7cd851cbb2f0ed281b41d5">msecsTo</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &t) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the difference between two time values (in milliseconds). <a href="#a425254ca9b7cd851cbb2f0ed281b41d5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8f4ea5cd7d712e13b2f48c9e734ce6b"></a><!-- doxytag: member="Wt::WTime::operator<" ref="ae8f4ea5cd7d712e13b2f48c9e734ce6b" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ae8f4ea5cd7d712e13b2f48c9e734ce6b">operator<</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad494013fd2bf5ad1d3d2360c5e2ba008"></a><!-- doxytag: member="Wt::WTime::operator<=" ref="ad494013fd2bf5ad1d3d2360c5e2ba008" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ad494013fd2bf5ad1d3d2360c5e2ba008">operator<=</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25c68de5cdd312a79096423e47d87008"></a><!-- doxytag: member="Wt::WTime::operator>" ref="a25c68de5cdd312a79096423e47d87008" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a25c68de5cdd312a79096423e47d87008">operator></a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae444c1b237d3d47bccf3b4acd8bc0456"></a><!-- doxytag: member="Wt::WTime::operator>=" ref="ae444c1b237d3d47bccf3b4acd8bc0456" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#ae444c1b237d3d47bccf3b4acd8bc0456">operator>=</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a260e9fc5c00732f3d2a8a0984339114c"></a><!-- doxytag: member="Wt::WTime::operator==" ref="a260e9fc5c00732f3d2a8a0984339114c" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a260e9fc5c00732f3d2a8a0984339114c">operator==</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a838f4a55e5a114b04af0d6285f016531"></a><!-- doxytag: member="Wt::WTime::operator!=" ref="a838f4a55e5a114b04af0d6285f016531" args="(const WTime &other) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a838f4a55e5a114b04af0d6285f016531">operator!=</a> (const <a class="el" href="classWt_1_1WTime.html">WTime</a> &other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two time values. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a34367d6f97d872d7598c1ba88b4fc95c">toString</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats this time to a string using a default format. <a href="#a34367d6f97d872d7598c1ba88b4fc95c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a02bf6eabd472474e73ef017414052751">toString</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &format) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats this time to a string using a specified format. <a href="#a02bf6eabd472474e73ef017414052751"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WTime.html">WTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a4937c5baf2c39affad90eace5e8178c5">fromString</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string to a time using a default format. <a href="#a4937c5baf2c39affad90eace5e8178c5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WTime.html">WTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a9be98d6095a48d81e4eeb7315403f5df">fromString</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &s, const <a class="el" href="classWt_1_1WString.html">WString</a> &format)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string to a time using a specified format. <a href="#a9be98d6095a48d81e4eeb7315403f5df"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WTime.html">WTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTime.html#a271bd124707e50cc15872e263ffa71f2">currentServerTime</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reports the current server time. <a href="#a271bd124707e50cc15872e263ffa71f2"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A value class that defines a clock time. </p> <p>A clock time represents the time of day (0 to 24 hour), up to millisecond precision.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDate.html" title="A value class that represents a date on the Gregorian calendar.">WDate</a>, <a class="el" href="classWt_1_1WDateTime.html" title="A calendar date and clock time.">WDateTime</a> </dd></dl> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="af45b86652752e63c00baee8662d793e3"></a><!-- doxytag: member="Wt::WTime::WTime" ref="af45b86652752e63c00baee8662d793e3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::WTime::WTime </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a <em>Null</em> time. </p> <p>A time for which <a class="el" href="classWt_1_1WTime.html#acfff1a1b2a4c38af39649491c15d516e" title="Returns if this time is Null.">isNull()</a> returns true. A <em>Null</em> time is also invalid.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a>, <a class="el" href="classWt_1_1WTime.html#acfff1a1b2a4c38af39649491c15d516e" title="Returns if this time is Null.">isNull()</a> </dd></dl> </div> </div> <a class="anchor" id="a529d211c58a37ad4568745414c4a25c8"></a><!-- doxytag: member="Wt::WTime::WTime" ref="a529d211c58a37ad4568745414c4a25c8" args="(int h, int m, int s=0, int ms=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::WTime::WTime </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>h</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>m</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>s</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>ms</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a time given hour, minutes, seconds, and milliseconds. </p> <p><code>h</code> has range 0-23, <code>m</code> and <code>s</code> have range 0-59, and <code>ms</code> has range 0-999.</p> <p>When the time is invalid, <a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a> is set to <code>false</code>. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a534f180014e634562dc808bc1e36e215"></a><!-- doxytag: member="Wt::WTime::addMSecs" ref="a534f180014e634562dc808bc1e36e215" args="(int ms) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WTime.html">WTime</a> Wt::WTime::addMSecs </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>ms</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Adds milliseconds. </p> <p>Returns a time that is <code>ms</code> milliseconds later than this time. Negative values for <code>ms</code> will result in a time that is as many milliseconds earlier. </p> </div> </div> <a class="anchor" id="a2779ca22acb1f51ad93320956501b251"></a><!-- doxytag: member="Wt::WTime::addSecs" ref="a2779ca22acb1f51ad93320956501b251" args="(int s) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WTime.html">WTime</a> Wt::WTime::addSecs </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>s</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Adds seconds. </p> <p>Returns a time that is <code>s</code> seconds later than this time. Negative values for <code>s</code> will result in a time that is as many seconds earlier. </p> </div> </div> <a class="anchor" id="a271bd124707e50cc15872e263ffa71f2"></a><!-- doxytag: member="Wt::WTime::currentServerTime" ref="a271bd124707e50cc15872e263ffa71f2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WTime.html">WTime</a> Wt::WTime::currentServerTime </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reports the current server time. </p> <p>This method returns the time as indicated by the system clock of the server. </p> </div> </div> <a class="anchor" id="a4937c5baf2c39affad90eace5e8178c5"></a><!-- doxytag: member="Wt::WTime::fromString" ref="a4937c5baf2c39affad90eace5e8178c5" args="(const WString &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WTime.html">WTime</a> Wt::WTime::fromString </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td> <td class="paramname"><em>s</em></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Parses a string to a time using a default format. </p> <p>The default format is "hh:mm:ss". For example, a time specified as: </p> <div class="fragment"><pre class="fragment"> <span class="stringliteral">"22:55:15"</span> </pre></div><p> will be parsed as a time that equals a time constructed as: </p> <div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WTime.html#af45b86652752e63c00baee8662d793e3" title="Construct a Null time.">WTime</a> d(22,55,15); </pre></div><p>When the time could not be parsed or is not valid, an invalid time is returned (for which <a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a> returns false).</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTime.html#a9be98d6095a48d81e4eeb7315403f5df" title="Parses a string to a time using a specified format.">fromString(const WString& s, const WString& format)</a>, <a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a> </dd></dl> </div> </div> <a class="anchor" id="a9be98d6095a48d81e4eeb7315403f5df"></a><!-- doxytag: member="Wt::WTime::fromString" ref="a9be98d6095a48d81e4eeb7315403f5df" args="(const WString &s, const WString &format)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WTime.html">WTime</a> Wt::WTime::fromString </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td> <td class="paramname"><em>format</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Parses a string to a time using a specified format. </p> <p>The <code>format</code> follows the same syntax as used by <a class="el" href="classWt_1_1WTime.html#a02bf6eabd472474e73ef017414052751">toString(const WString& format)</a>.</p> <p>When the time could not be parsed or is not valid, an invalid time is returned (for which <a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a> returns false).</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTime.html#a02bf6eabd472474e73ef017414052751" title="Formats this time to a string using a specified format.">toString(const WString&) const</a> </dd></dl> </div> </div> <a class="anchor" id="acfff1a1b2a4c38af39649491c15d516e"></a><!-- doxytag: member="Wt::WTime::isNull" ref="acfff1a1b2a4c38af39649491c15d516e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Wt::WTime::isNull </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns if this time is <em>Null</em>. </p> <p>A null time is also invalid.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a>, <a class="el" href="classWt_1_1WTime.html#af45b86652752e63c00baee8662d793e3" title="Construct a Null time.">WTime()</a> </dd></dl> </div> </div> <a class="anchor" id="a425254ca9b7cd851cbb2f0ed281b41d5"></a><!-- doxytag: member="Wt::WTime::msecsTo" ref="a425254ca9b7cd851cbb2f0ed281b41d5" args="(const WTime &t) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Wt::WTime::msecsTo </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WTime.html">WTime</a> & </td> <td class="paramname"><em>t</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the difference between two time values (in milliseconds). </p> <p>This returns a value between -86400000 ms and 86400000 ms.</p> <p>The result is negative if t is earlier than this. </p> </div> </div> <a class="anchor" id="a53bc25995b5c3cd1bcffd2e0d562e08d"></a><!-- doxytag: member="Wt::WTime::secsTo" ref="a53bc25995b5c3cd1bcffd2e0d562e08d" args="(const WTime &t) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Wt::WTime::secsTo </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WTime.html">WTime</a> & </td> <td class="paramname"><em>t</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the difference between two time values (in seconds). </p> <p>This returns a value between -86400 s and 86400 s.</p> <p>The result is negative if t is earlier than this. </p> </div> </div> <a class="anchor" id="ae506c60945d8c2a452233ade046fa9ac"></a><!-- doxytag: member="Wt::WTime::setHMS" ref="ae506c60945d8c2a452233ade046fa9ac" args="(int h, int m, int s, int ms=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Wt::WTime::setHMS </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>h</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>m</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>ms</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the time. </p> <p><code>h</code> has range 0-23, <code>m</code> and <code>s</code> have range 0-59, and <code>ms</code> has range 0-999.</p> <p>When the time is invalid, <a class="el" href="classWt_1_1WTime.html#aa8e2713bf2844daeaf97820224a941ac" title="Returns if this time is valid.">isValid()</a> is set to <code>false</code>. </p> </div> </div> <a class="anchor" id="a34367d6f97d872d7598c1ba88b4fc95c"></a><!-- doxytag: member="Wt::WTime::toString" ref="a34367d6f97d872d7598c1ba88b4fc95c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WTime::toString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Formats this time to a string using a default format. </p> <p>The default format is "hh:mm:ss". </p> </div> </div> <a class="anchor" id="a02bf6eabd472474e73ef017414052751"></a><!-- doxytag: member="Wt::WTime::toString" ref="a02bf6eabd472474e73ef017414052751" args="(const WString &format) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WTime::toString </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td> <td class="paramname"><em>format</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Formats this time to a string using a specified format. </p> <p>The <code>format</code> is a string in which the following contents has a special meaning.</p> <table class="doxtable"> <tr> <td><b>Code</b></td><td><b>Meaning</b> </td><td><b>Example (for 14:06:23.045)</b> </td></tr> <tr> <td>h</td><td>The hour without leading zero (0-23 or 1-12 for AM/PM display) </td><td>14 or 2 </td></tr> <tr> <td>hh</td><td>The hour with leading zero (00-23 or 01-12 for AM/PM display) </td><td>14 or 02 </td></tr> <tr> <td>H</td><td>The hour without leading zero (0-23) </td><td>14 </td></tr> <tr> <td>HH</td><td>The hour with leading zero (00-23) </td><td>14 </td></tr> <tr> <td>m</td><td>The minutes without leading zero (0-59) </td><td>6 </td></tr> <tr> <td>mm</td><td>The minutes with leading zero (00-59) </td><td>06 </td></tr> <tr> <td>s</td><td>The seconds without leading zero (0-59) </td><td>23 </td></tr> <tr> <td>ss</td><td>The seconds with leading zero (00-59) </td><td>23 </td></tr> <tr> <td>z</td><td>The milliseconds without leading zero (0-999) </td><td>45 </td></tr> <tr> <td>zzz</td><td>The millisecons with leading zero (000-999) </td><td>045 </td></tr> <tr> <td>AP or A</td><td>use AM/PM display: affects h or hh display and is replaced itself by AM/PM </td><td>PM </td></tr> <tr> <td>ap or a</td><td>use am/pm display: affects h or hh display and is replaced itself by am/pm </td><td>pm </td></tr> </table> <p>Any other text is kept literally. String content between single quotes (') are not interpreted as special codes. Inside a string, a literal quote may be specifed using a double quote ('').</p> <p>Examples of format and result: </p> <table class="doxtable"> <tr> <td><b>Format</b></td><td><b>Result (for 22:53:13.078)</b> </td></tr> <tr> <td>hh:mm:ss.zzz</td><td>22:53:13.078 </td></tr> <tr> <td>hh:mm:ss AP</td><td>10:53:13 PM </td></tr> </table> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTime.html#a9be98d6095a48d81e4eeb7315403f5df" title="Parses a string to a time using a specified format.">fromString(const WString& value, const WString& format)</a> </dd></dl> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr size="1"><address style="text-align: right; margin: 3px"><small> Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the C++ Web Toolkit (Wt)</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0" style="vertical-align: middle; display: inline-block; height: 2em"></a> 1.7.5.1</small></address> </body> </html>