namespacehueplusplus_1_1utils.html 11.1 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: hueplusplus::utils Namespace 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_1utils.html">utils</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">hueplusplus::utils Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Utility functions used in multiple places.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abc293509e3c09a90a1324e2f657dcce7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1utils.html#abc293509e3c09a90a1324e2f657dcce7">validatePUTReply</a> (const std::string &amp;path, const nlohmann::json &amp;request, const nlohmann::json &amp;reply)</td></tr>
<tr class="memdesc:abc293509e3c09a90a1324e2f657dcce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for validating that a request was executed correctly.  <a href="#abc293509e3c09a90a1324e2f657dcce7">More...</a><br /></td></tr>
<tr class="separator:abc293509e3c09a90a1324e2f657dcce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97489af5c31e43274bc4b502293cad33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1utils.html#a97489af5c31e43274bc4b502293cad33">validateReplyForLight</a> (const nlohmann::json &amp;request, const nlohmann::json &amp;reply, int lightId)</td></tr>
<tr class="separator:a97489af5c31e43274bc4b502293cad33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd53f5a43053f94209d8195fc4674665"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1utils.html#abd53f5a43053f94209d8195fc4674665">floatEquals</a> (float lhs, float rhs)</td></tr>
<tr class="memdesc:abd53f5a43053f94209d8195fc4674665"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks equality to 4 decimal places.  <a href="#abd53f5a43053f94209d8195fc4674665">More...</a><br /></td></tr>
<tr class="separator:abd53f5a43053f94209d8195fc4674665"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6268e7923eee8d5300471820c3d8094"><td class="memTemplParams" colspan="2">template&lt;typename... Paths&gt; </td></tr>
<tr class="memitem:ae6268e7923eee8d5300471820c3d8094"><td class="memTemplItemLeft" align="right" valign="top">nlohmann::json&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1utils.html#ae6268e7923eee8d5300471820c3d8094">safeGetMember</a> (const nlohmann::json &amp;json, Paths &amp;&amp;... paths)</td></tr>
<tr class="memdesc:ae6268e7923eee8d5300471820c3d8094"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object/array member or null if it does not exist.  <a href="#ae6268e7923eee8d5300471820c3d8094">More...</a><br /></td></tr>
<tr class="separator:ae6268e7923eee8d5300471820c3d8094"><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>Utility functions used in multiple places. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="abd53f5a43053f94209d8195fc4674665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd53f5a43053f94209d8195fc4674665">&#9670;&nbsp;</a></span>floatEquals()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool hueplusplus::utils::floatEquals </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>lhs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>rhs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>Checks equality to 4 decimal places. </p>
<p>Floats in Hue json responses are rounded to 4 decimal places. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Paths&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">nlohmann::json hueplusplus::utils::safeGetMember </td>
          <td>(</td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>json</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Paths &amp;&amp;...&#160;</td>
          <td class="paramname"><em>paths</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the object/array member or null if it does not exist. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">json</td><td>The base json value </td></tr>
    <tr><td class="paramname">paths</td><td>Any number of child accesses (e.g. 0, "key" would access json[0]["key"]) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The specified member or null if any intermediate object does not contain the specified child. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool hueplusplus::utils::validatePUTReply </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>reply</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for validating that a request was executed correctly. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>The path the PUT request was made to </td></tr>
    <tr><td class="paramname">request</td><td>The request that was sent initially </td></tr>
    <tr><td class="paramname">reply</td><td>The reply that was received </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if request was executed correctly </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool hueplusplus::utils::validateReplyForLight </td>
          <td>(</td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>reply</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>lightId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</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>