_utils_8h_source.html
15.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<!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/Utils.h Source File</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
 <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="headertitle">
<div class="title">Utils.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_utils_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDE_HUEPLUSPLUS_UTILS_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define INCLUDE_HUEPLUSPLUS_UTILS_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "json/json.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacehueplusplus.html">hueplusplus</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacehueplusplus_1_1utils.html"> 31</a></span> <span class="keyword">namespace </span>utils</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>detail</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Forward declaration</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">template</span> <<span class="keyword">typename</span> KeyT, <span class="keyword">typename</span>... Paths></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> nlohmann::json safeGetMemberHelper(<span class="keyword">const</span> nlohmann::json& json, std::size_t index, Paths&&... otherPaths);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">inline</span> nlohmann::json safeGetMemberHelper(<span class="keyword">const</span> nlohmann::json& json)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> json;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span> <<span class="keyword">typename</span> KeyT, <span class="keyword">typename</span>... Paths,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::enable_if_t<!std::is_integral<std::remove_reference_t<KeyT>>::value>* = <span class="keyword">nullptr</span>></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> nlohmann::json safeGetMemberHelper(<span class="keyword">const</span> nlohmann::json& json, KeyT&& key, Paths&&... otherPaths)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">auto</span> memberIt = json.find(std::forward<KeyT>(key));</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">if</span> (memberIt == json.end())</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> safeGetMemberHelper(*memberIt, std::forward<Paths>(otherPaths)...);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Needs to be after the other safeGetMemberHelper, otherwise another forward declaration is needed</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... Paths></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> nlohmann::json safeGetMemberHelper(<span class="keyword">const</span> nlohmann::json& json, std::size_t index, Paths&&... otherPaths)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">if</span> (!json.is_array() || json.size() <= index)</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> safeGetMemberHelper(json[index], std::forward<Paths>(otherPaths)...);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> } <span class="comment">// namespace detail</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">bool</span> <a class="code" href="namespacehueplusplus_1_1utils.html#abc293509e3c09a90a1324e2f657dcce7">validatePUTReply</a>(<span class="keyword">const</span> std::string& path, <span class="keyword">const</span> nlohmann::json& request, <span class="keyword">const</span> nlohmann::json& reply);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">bool</span> <a class="code" href="namespacehueplusplus_1_1utils.html#a97489af5c31e43274bc4b502293cad33">validateReplyForLight</a>(<span class="keyword">const</span> nlohmann::json& request, <span class="keyword">const</span> nlohmann::json& reply, <span class="keywordtype">int</span> lightId);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="namespacehueplusplus_1_1utils.html#abd53f5a43053f94209d8195fc4674665"> 81</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacehueplusplus_1_1utils.html#abd53f5a43053f94209d8195fc4674665">floatEquals</a>(<span class="keywordtype">float</span> lhs, <span class="keywordtype">float</span> rhs)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> std::abs(lhs - rhs) <= 1E-4f;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... Paths></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="namespacehueplusplus_1_1utils.html#ae6268e7923eee8d5300471820c3d8094"> 92</a></span> nlohmann::json <a class="code" href="namespacehueplusplus_1_1utils.html#ae6268e7923eee8d5300471820c3d8094">safeGetMember</a>(<span class="keyword">const</span> nlohmann::json& json, Paths&&... paths)</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> detail::safeGetMemberHelper(json, std::forward<Paths>(paths)...);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace utils</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">namespace </span>detail</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">class </span>MakeCopyable : <span class="keyword">public</span> T</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// Make copy constructor and assignment operator public</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">using</span> T::T;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">using</span> T::operator=;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> };</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> } <span class="comment">// namespace detail</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> } <span class="comment">// namespace hueplusplus</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespacehueplusplus_html"><div class="ttname"><a href="namespacehueplusplus.html">hueplusplus</a></div><div class="ttdoc">Namespace for the hueplusplus library. </div><div class="ttdef"><b>Definition:</b> Action.h:27</div></div>
<div class="ttc" id="namespacehueplusplus_1_1utils_html_a97489af5c31e43274bc4b502293cad33"><div class="ttname"><a href="namespacehueplusplus_1_1utils.html#a97489af5c31e43274bc4b502293cad33">hueplusplus::utils::validateReplyForLight</a></div><div class="ttdeci">bool validateReplyForLight(const nlohmann::json &request, const nlohmann::json &reply, int lightId)</div><div class="ttdef"><b>Definition:</b> Utils.cpp:89</div></div>
<div class="ttc" id="namespacehueplusplus_1_1utils_html_abc293509e3c09a90a1324e2f657dcce7"><div class="ttname"><a href="namespacehueplusplus_1_1utils.html#abc293509e3c09a90a1324e2f657dcce7">hueplusplus::utils::validatePUTReply</a></div><div class="ttdeci">bool validatePUTReply(const std::string &path, const nlohmann::json &request, const nlohmann::json &reply)</div><div class="ttdoc">Function for validating that a request was executed correctly. </div><div class="ttdef"><b>Definition:</b> Utils.cpp:31</div></div>
<div class="ttc" id="namespacehueplusplus_1_1utils_html_abd53f5a43053f94209d8195fc4674665"><div class="ttname"><a href="namespacehueplusplus_1_1utils.html#abd53f5a43053f94209d8195fc4674665">hueplusplus::utils::floatEquals</a></div><div class="ttdeci">bool floatEquals(float lhs, float rhs)</div><div class="ttdoc">Checks equality to 4 decimal places. </div><div class="ttdef"><b>Definition:</b> Utils.h:81</div></div>
<div class="ttc" id="namespacehueplusplus_1_1utils_html_ae6268e7923eee8d5300471820c3d8094"><div class="ttname"><a href="namespacehueplusplus_1_1utils.html#ae6268e7923eee8d5300471820c3d8094">hueplusplus::utils::safeGetMember</a></div><div class="ttdeci">nlohmann::json safeGetMember(const nlohmann::json &json, Paths &&... paths)</div><div class="ttdoc">Returns the object/array member or null if it does not exist. </div><div class="ttdef"><b>Definition:</b> Utils.h:92</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>