<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>log4shib: log4shib::TimeStamp Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">log4shib  <span id="projectnumber">1.0.8</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="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="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</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> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespacelog4shib.html">log4shib</a></li><li class="navelem"><a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="#pro-static-attribs">Static Protected Attributes</a> | <a href="classlog4shib_1_1TimeStamp-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">log4shib::TimeStamp Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A simple <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> abstraction. <a href="classlog4shib_1_1TimeStamp.html#details">More...</a></p> <p><code>#include <<a class="el" href="TimeStamp_8hh_source.html">TimeStamp.hh</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:adb52450ec73896e6e9d3fee947bfccef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#adb52450ec73896e6e9d3fee947bfccef">TimeStamp</a> ()</td></tr> <tr class="memdesc:adb52450ec73896e6e9d3fee947bfccef"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing 'now'. <a href="#adb52450ec73896e6e9d3fee947bfccef">More...</a><br /></td></tr> <tr class="separator:adb52450ec73896e6e9d3fee947bfccef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0355456b5dd25c7c01e4fafb53f57fca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a0355456b5dd25c7c01e4fafb53f57fca">TimeStamp</a> (unsigned int seconds, unsigned int microSeconds=0)</td></tr> <tr class="memdesc:a0355456b5dd25c7c01e4fafb53f57fca"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing the given offset since the epoch ( 00:00:00 1970/1/1 UTC). <a href="#a0355456b5dd25c7c01e4fafb53f57fca">More...</a><br /></td></tr> <tr class="separator:a0355456b5dd25c7c01e4fafb53f57fca"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e6b582ea1622c79f57c8ead9a074d68"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a9e6b582ea1622c79f57c8ead9a074d68">getSeconds</a> () const </td></tr> <tr class="memdesc:a9e6b582ea1622c79f57c8ead9a074d68"><td class="mdescLeft"> </td><td class="mdescRight">Returns the 'seconds' part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a>. <a href="#a9e6b582ea1622c79f57c8ead9a074d68">More...</a><br /></td></tr> <tr class="separator:a9e6b582ea1622c79f57c8ead9a074d68"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9127678a231c319724e78f88a34c958e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a9127678a231c319724e78f88a34c958e">getMilliSeconds</a> () const </td></tr> <tr class="memdesc:a9127678a231c319724e78f88a34c958e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the 'subseconds' part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> in milliseconds, <a class="el" href="classlog4shib_1_1TimeStamp.html#a9127678a231c319724e78f88a34c958e" title="Returns the 'subseconds' part of the TimeStamp in milliseconds, getMilliSeconds() == getMicroSeconds(...">getMilliSeconds()</a> == <a class="el" href="classlog4shib_1_1TimeStamp.html#af1a7549f0de63e590467a6ba70bc79c7" title="Returns the subsecond part of the TimeStamp in microseconds. ">getMicroSeconds()</a> / 1000. <a href="#a9127678a231c319724e78f88a34c958e">More...</a><br /></td></tr> <tr class="separator:a9127678a231c319724e78f88a34c958e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af1a7549f0de63e590467a6ba70bc79c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#af1a7549f0de63e590467a6ba70bc79c7">getMicroSeconds</a> () const </td></tr> <tr class="memdesc:af1a7549f0de63e590467a6ba70bc79c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the subsecond part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> in microseconds. <a href="#af1a7549f0de63e590467a6ba70bc79c7">More...</a><br /></td></tr> <tr class="separator:af1a7549f0de63e590467a6ba70bc79c7"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a584ab127dcff56f9bc3100218ea7418f"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a584ab127dcff56f9bc3100218ea7418f">getStartTime</a> ()</td></tr> <tr class="memdesc:a584ab127dcff56f9bc3100218ea7418f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing the time at which the application started. <a href="#a584ab127dcff56f9bc3100218ea7418f">More...</a><br /></td></tr> <tr class="separator:a584ab127dcff56f9bc3100218ea7418f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:abdd24f6ba9a7038b32f45362707328a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#abdd24f6ba9a7038b32f45362707328a8">_seconds</a></td></tr> <tr class="separator:abdd24f6ba9a7038b32f45362707328a8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a79d3317879bc20ee4269b3b70ba3320c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a79d3317879bc20ee4269b3b70ba3320c">_microSeconds</a></td></tr> <tr class="separator:a79d3317879bc20ee4269b3b70ba3320c"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a> Static Protected Attributes</h2></td></tr> <tr class="memitem:a63f405c018f0f507ccd227f49668eafc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1TimeStamp.html#a63f405c018f0f507ccd227f49668eafc">_startStamp</a></td></tr> <tr class="separator:a63f405c018f0f507ccd227f49668eafc"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A simple <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> abstraction. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="adb52450ec73896e6e9d3fee947bfccef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4shib::TimeStamp::TimeStamp </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing 'now'. </p> </div> </div> <a class="anchor" id="a0355456b5dd25c7c01e4fafb53f57fca"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4shib::TimeStamp::TimeStamp </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>seconds</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>microSeconds</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing the given offset since the epoch ( 00:00:00 1970/1/1 UTC). </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="af1a7549f0de63e590467a6ba70bc79c7"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int log4shib::TimeStamp::getMicroSeconds </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the subsecond part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> in microseconds. </p> <p>The actual precision of this value depends on the platform and may be in the order of milliseconds rather than microseconds. </p> </div> </div> <a class="anchor" id="a9127678a231c319724e78f88a34c958e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int log4shib::TimeStamp::getMilliSeconds </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the 'subseconds' part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> in milliseconds, <a class="el" href="classlog4shib_1_1TimeStamp.html#a9127678a231c319724e78f88a34c958e" title="Returns the 'subseconds' part of the TimeStamp in milliseconds, getMilliSeconds() == getMicroSeconds(...">getMilliSeconds()</a> == <a class="el" href="classlog4shib_1_1TimeStamp.html#af1a7549f0de63e590467a6ba70bc79c7" title="Returns the subsecond part of the TimeStamp in microseconds. ">getMicroSeconds()</a> / 1000. </p> </div> </div> <a class="anchor" id="a9e6b582ea1622c79f57c8ead9a074d68"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int log4shib::TimeStamp::getSeconds </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the 'seconds' part of the <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a>. </p> </div> </div> <a class="anchor" id="a584ab127dcff56f9bc3100218ea7418f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static const <a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a>& log4shib::TimeStamp::getStartTime </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a <a class="el" href="classlog4shib_1_1TimeStamp.html" title="A simple TimeStamp abstraction. ">TimeStamp</a> representing the time at which the application started. </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a79d3317879bc20ee4269b3b70ba3320c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int log4shib::TimeStamp::_microSeconds</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="abdd24f6ba9a7038b32f45362707328a8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int log4shib::TimeStamp::_seconds</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a63f405c018f0f507ccd227f49668eafc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlog4shib_1_1TimeStamp.html">TimeStamp</a> log4shib::TimeStamp::_startStamp</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="TimeStamp_8hh_source.html">TimeStamp.hh</a></li> <li><a class="el" href="TimeStamp_8cpp.html">TimeStamp.cpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 16 2014 02:10:55 for log4shib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>