classhueplusplus_1_1time_1_1_absolute_time.html 14.2 KB

Edit Raw Blame History

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::time::AbsoluteTime 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">hueplusplus
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="namespacehueplusplus_1_1time.html">time</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classhueplusplus_1_1time_1_1_absolute_time-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">hueplusplus::time::AbsoluteTime Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>One-time, absolute time point.
 <a href="classhueplusplus_1_1time_1_1_absolute_time.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_time_pattern_8h_source.html">hueplusplus/TimePattern.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for hueplusplus::time::AbsoluteTime:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classhueplusplus_1_1time_1_1_absolute_time__inherit__graph.png" border="0" usemap="#hueplusplus_1_1time_1_1_absolute_time_inherit__map" alt="Inheritance graph"/></div>
<map name="hueplusplus_1_1time_1_1_absolute_time_inherit__map" id="hueplusplus_1_1time_1_1_absolute_time_inherit__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1time_1_1_absolute_varied_time.html" title="hueplusplus::time::\lAbsoluteVariedTime" alt="" coords="5,95,159,136"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a78ed85e1ea1356be6dbf319385498b30"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#a78ed85e1ea1356be6dbf319385498b30">AbsoluteTime</a> (clock::time_point baseTime)</td></tr>
<tr class="memdesc:a78ed85e1ea1356be6dbf319385498b30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create absolute time point.  <a href="#a78ed85e1ea1356be6dbf319385498b30">More...</a><br /></td></tr>
<tr class="separator:a78ed85e1ea1356be6dbf319385498b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8db3aa8a4f512313791980dcd78c537e"><td class="memItemLeft" align="right" valign="top">clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#a8db3aa8a4f512313791980dcd78c537e">getBaseTime</a> () const</td></tr>
<tr class="memdesc:a8db3aa8a4f512313791980dcd78c537e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get base time point.  <a href="#a8db3aa8a4f512313791980dcd78c537e">More...</a><br /></td></tr>
<tr class="separator:a8db3aa8a4f512313791980dcd78c537e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2581f035406533868d71e4c234f513d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#ab2581f035406533868d71e4c234f513d">toString</a> () const</td></tr>
<tr class="memdesc:ab2581f035406533868d71e4c234f513d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get formatted string as expected by Hue API.  <a href="#ab2581f035406533868d71e4c234f513d">More...</a><br /></td></tr>
<tr class="separator:ab2581f035406533868d71e4c234f513d"><td class="memSeparator" colspan="2">&#160;</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:ace5da237dfaf5e1b524d378e47c98828"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#ace5da237dfaf5e1b524d378e47c98828">parse</a> (const std::string &amp;s)</td></tr>
<tr class="memdesc:ace5da237dfaf5e1b524d378e47c98828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> from formatted string in local timezone.  <a href="#ace5da237dfaf5e1b524d378e47c98828">More...</a><br /></td></tr>
<tr class="separator:ace5da237dfaf5e1b524d378e47c98828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96322623cd27d6dad3fb7276475a098d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#a96322623cd27d6dad3fb7276475a098d">parseUTC</a> (const std::string &amp;s)</td></tr>
<tr class="memdesc:a96322623cd27d6dad3fb7276475a098d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> from formatted UTC string.  <a href="#a96322623cd27d6dad3fb7276475a098d">More...</a><br /></td></tr>
<tr class="separator:a96322623cd27d6dad3fb7276475a098d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>One-time, absolute time point. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a78ed85e1ea1356be6dbf319385498b30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78ed85e1ea1356be6dbf319385498b30">&#9670;&nbsp;</a></span>AbsoluteTime()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">hueplusplus::time::AbsoluteTime::AbsoluteTime </td>
          <td>(</td>
          <td class="paramtype">clock::time_point&#160;</td>
          <td class="paramname"><em>baseTime</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create absolute time point. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">baseTime</td><td>Absolute time point </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8db3aa8a4f512313791980dcd78c537e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8db3aa8a4f512313791980dcd78c537e">&#9670;&nbsp;</a></span>getBaseTime()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">system_clock::time_point hueplusplus::time::AbsoluteTime::getBaseTime </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get base time point. </p>
<p>Can be used for calculation with other system_clock time_points </p>

</div>
</div>
<a id="ace5da237dfaf5e1b524d378e47c98828"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace5da237dfaf5e1b524d378e47c98828">&#9670;&nbsp;</a></span>parse()</h2>

<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="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a> hueplusplus::time::AbsoluteTime::parse </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> from formatted string in local timezone. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>Timestamp in the same format as returned by <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#ab2581f035406533868d71e4c234f513d">toString()</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> with base time and variation from <code>s</code> </dd></dl>

</div>
</div>
<a id="a96322623cd27d6dad3fb7276475a098d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96322623cd27d6dad3fb7276475a098d">&#9670;&nbsp;</a></span>parseUTC()</h2>

<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="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a> hueplusplus::time::AbsoluteTime::parseUTC </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> from formatted UTC string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>Timestamp in the same format as returned by <a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html#ab2581f035406533868d71e4c234f513d">toString()</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html" title="One-time, absolute time point. ">AbsoluteTime</a> with base time and variation from <code>s</code> </dd></dl>

</div>
</div>
<a id="ab2581f035406533868d71e4c234f513d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2581f035406533868d71e4c234f513d">&#9670;&nbsp;</a></span>toString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string hueplusplus::time::AbsoluteTime::toString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get formatted string as expected by Hue API. </p>
<dl class="section return"><dt>Returns</dt><dd>Timestamp in the format <code>YYYY-MM-DD</code><b>T</b><code>hh:mm:ss</code> in local timezone </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_time_pattern_8h_source.html">TimePattern.h</a></li>
<li>src/<a class="el" href="_time_pattern_8cpp.html">TimePattern.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>