_time_pattern_8h.html 17.5 KB

Edit Raw Blame History Permalink

<!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: include/hueplusplus/TimePattern.h File 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e05b4b7707bd5f9fd045e8be02b17d0a.html">hueplusplus</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">TimePattern.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;chrono&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;cstddef&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for TimePattern.h:</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="_time_pattern_8h__incl.png" border="0" usemap="#include_2hueplusplus_2_time_pattern_8h" alt=""/></div>
<map name="include_2hueplusplus_2_time_pattern_8h" id="include_2hueplusplus_2_time_pattern_8h">
</map>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="_time_pattern_8h__dep__incl.png" border="0" usemap="#include_2hueplusplus_2_time_pattern_8hdep" alt=""/></div>
<map name="include_2hueplusplus_2_time_pattern_8hdep" id="include_2hueplusplus_2_time_pattern_8hdep">
<area shape="rect" id="node2" href="_bridge_config_8h.html" title="include/hueplusplus\l/BridgeConfig.h" alt="" coords="26,95,177,136"/>
<area shape="rect" id="node12" href="_new_device_list_8h.html" title="include/hueplusplus\l/NewDeviceList.h" alt="" coords="572,95,722,136"/>
<area shape="rect" id="node16" href="_condition_8h.html" title="include/hueplusplus\l/Condition.h" alt="" coords="973,95,1124,136"/>
<area shape="rect" id="node17" href="_rule_8h.html" title="include/hueplusplus\l/Rule.h" alt="" coords="964,184,1114,225"/>
<area shape="rect" id="node19" href="_sensor_8h.html" title="include/hueplusplus\l/Sensor.h" alt="" coords="1138,184,1289,225"/>
<area shape="rect" id="node25" href="_scene_8h.html" title="include/hueplusplus\l/Scene.h" alt="" coords="234,95,385,136"/>
<area shape="rect" id="node27" href="_schedule_8h.html" title="include/hueplusplus\l/Schedule.h" alt="" coords="746,95,897,136"/>
<area shape="rect" id="node29" href="_time_pattern_8cpp.html" title="src/TimePattern.cpp" alt="" coords="1200,102,1350,129"/>
<area shape="rect" id="node3" href="_bridge_8h.html" title="include/hueplusplus\l/Bridge.h" alt="" coords="582,363,733,404"/>
<area shape="rect" id="node11" href="_bridge_config_8cpp.html" title="src/BridgeConfig.cpp" alt="" coords="24,191,179,218"/>
<area shape="rect" id="node4" href="_entertainment_mode_8h.html" title="include/hueplusplus\l/EntertainmentMode.h" alt="" coords="969,452,1136,493"/>
<area shape="rect" id="node6" href="_bridge_8cpp.html" title="src/Bridge.cpp" alt="" coords="162,459,276,486"/>
<area shape="rect" id="node7" href="_bridge_setup_8cpp.html" title="examples/BridgeSetup.cpp" alt="" coords="301,459,497,486"/>
<area shape="rect" id="node8" href="_lights_off_8cpp.html" title="examples/LightsOff.cpp" alt="" coords="521,459,696,486"/>
<area shape="rect" id="node9" href="_snippets_8cpp.html" title="Contains code snippets used in the documentation, performs no useful functions. " alt="" coords="1160,459,1334,486"/>
<area shape="rect" id="node10" href="_username_config_8cpp.html" title="examples/UsernameConfig.cpp" alt="" coords="720,459,945,486"/>
<area shape="rect" id="node5" href="_entertainment_mode_8cpp.html" title="src/EntertainmentMode.cpp" alt="" coords="952,541,1152,568"/>
<area shape="rect" id="node13" href="_resource_list_8h.html" title="include/hueplusplus\l/ResourceList.h" alt="" coords="582,184,733,225"/>
<area shape="rect" id="node15" href="_new_device_list_8cpp.html" title="src/NewDeviceList.cpp" alt="" coords="389,191,558,218"/>
<area shape="rect" id="node14" href="_sensor_list_8h.html" title="include/hueplusplus\l/SensorList.h" alt="" coords="582,273,733,315"/>
<area shape="rect" id="node18" href="_rule_8cpp.html" title="src/Rule.cpp" alt="" coords="917,281,1017,307"/>
<area shape="rect" id="node20" href="_c_l_i_p_sensors_8h.html" title="include/hueplusplus\l/CLIPSensors.h" alt="" coords="1406,273,1557,315"/>
<area shape="rect" id="node22" href="_z_l_l_sensors_8h.html" title="include/hueplusplus\l/ZLLSensors.h" alt="" coords="1232,273,1382,315"/>
<area shape="rect" id="node24" href="_sensor_8cpp.html" title="src/Sensor.cpp" alt="" coords="1042,281,1156,307"/>
<area shape="rect" id="node21" href="_c_l_i_p_sensors_8cpp.html" title="src/CLIPSensors.cpp" alt="" coords="1405,370,1556,397"/>
<area shape="rect" id="node23" href="_z_l_l_sensors_8cpp.html" title="src/ZLLSensors.cpp" alt="" coords="1234,370,1380,397"/>
<area shape="rect" id="node26" href="_scene_8cpp.html" title="src/Scene.cpp" alt="" coords="254,191,365,218"/>
<area shape="rect" id="node28" href="_schedule_8cpp.html" title="src/Schedule.cpp" alt="" coords="808,191,939,218"/>
</map>
</div>
</div>
<p><a href="_time_pattern_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html">hueplusplus::time::AbsoluteTime</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One-time, absolute time point.  <a href="classhueplusplus_1_1time_1_1_absolute_time.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_varied_time.html">hueplusplus::time::AbsoluteVariedTime</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">hueplusplus::time::Weekdays</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Any number of days of the week.  <a href="classhueplusplus_1_1time_1_1_weekdays.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html">hueplusplus::time::RecurringTime</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time repeated weekly to daily, with possible random variation.  <a href="classhueplusplus_1_1time_1_1_recurring_time.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_time_interval.html">hueplusplus::time::TimeInterval</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time interval repeated daily to weekly.  <a href="classhueplusplus_1_1time_1_1_time_interval.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html">hueplusplus::time::Timer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html" title="Timer that is started and triggers after specified delay. ">Timer</a> that is started and triggers after specified delay.  <a href="classhueplusplus_1_1time_1_1_timer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_time_pattern.html">hueplusplus::time::TimePattern</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds different time representations.  <a href="classhueplusplus_1_1time_1_1_time_pattern.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacehueplusplus"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></td></tr>
<tr class="memdesc:namespacehueplusplus"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for the hueplusplus library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacehueplusplus_1_1time"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html">hueplusplus::time</a></td></tr>
<tr class="memdesc:namespacehueplusplus_1_1time"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for time/date related classes and functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afd15eb6e086c8242a2e202536fa4c02b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#afd15eb6e086c8242a2e202536fa4c02b">hueplusplus::time::timepointToTimestamp</a> (std::chrono::system_clock::time_point time)</td></tr>
<tr class="memdesc:afd15eb6e086c8242a2e202536fa4c02b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a time_point to a timestamp string.  <a href="namespacehueplusplus_1_1time.html#afd15eb6e086c8242a2e202536fa4c02b">More...</a><br /></td></tr>
<tr class="separator:afd15eb6e086c8242a2e202536fa4c02b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84b6a46eb1f4a03ab7740104a8616007"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#a84b6a46eb1f4a03ab7740104a8616007">hueplusplus::time::parseTimestamp</a> (const std::string &amp;timestamp)</td></tr>
<tr class="memdesc:a84b6a46eb1f4a03ab7740104a8616007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a timestamp to a time_point.  <a href="namespacehueplusplus_1_1time.html#a84b6a46eb1f4a03ab7740104a8616007">More...</a><br /></td></tr>
<tr class="separator:a84b6a46eb1f4a03ab7740104a8616007"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31275be9b8ff39ee8445787b59ad1235"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#a31275be9b8ff39ee8445787b59ad1235">hueplusplus::time::parseUTCTimestamp</a> (const std::string &amp;timestamp)</td></tr>
<tr class="memdesc:a31275be9b8ff39ee8445787b59ad1235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an UTC timestamp to a time_point.  <a href="namespacehueplusplus_1_1time.html#a31275be9b8ff39ee8445787b59ad1235">More...</a><br /></td></tr>
<tr class="separator:a31275be9b8ff39ee8445787b59ad1235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeee784c375bcc301727eab3fe8e67d03"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#aeee784c375bcc301727eab3fe8e67d03">hueplusplus::time::durationTo_hh_mm_ss</a> (std::chrono::system_clock::duration duration)</td></tr>
<tr class="memdesc:aeee784c375bcc301727eab3fe8e67d03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts duration to a time string.  <a href="namespacehueplusplus_1_1time.html#aeee784c375bcc301727eab3fe8e67d03">More...</a><br /></td></tr>
<tr class="separator:aeee784c375bcc301727eab3fe8e67d03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee172420a332a222f34f9e9eaf6c5621"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::duration&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#aee172420a332a222f34f9e9eaf6c5621">hueplusplus::time::parseDuration</a> (const std::string &amp;hourMinSec)</td></tr>
<tr class="memdesc:aee172420a332a222f34f9e9eaf6c5621"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts time string to a duration.  <a href="namespacehueplusplus_1_1time.html#aee172420a332a222f34f9e9eaf6c5621">More...</a><br /></td></tr>
<tr class="separator:aee172420a332a222f34f9e9eaf6c5621"><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>Copyright Notice<br />
Copyright (C) 2020 Jan Rogall - developer<br />
 This file is part of hueplusplus.</p>
<p>hueplusplus is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>hueplusplus is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with hueplusplus. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
</div></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>