_action_8h_source.html
13.5 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
84
85
86
87
88
89
90
91
<!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/Action.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">Action.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_action_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="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef INCLUDE_HUEPLUSPLUS_ACTION_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define INCLUDE_HUEPLUSPLUS_ACTION_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "json/json.hpp"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacehueplusplus.html"> 27</a></span> <span class="keyword">namespace </span><a class="code" href="namespacehueplusplus.html">hueplusplus</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classhueplusplus_1_1_action.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classhueplusplus_1_1_action.html">Action</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">explicit</span> <a class="code" href="classhueplusplus_1_1_action.html#a581153171ecf44ce583e088c9bd6f048">Action</a>(<span class="keyword">const</span> nlohmann::json& json);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542"> 43</a></span>  <span class="keyword">enum class</span> <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a42b90196b487c54069097a68fe98ab6f">post</a>, </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a8e13ffc9fd9d6a6761231a764bdf106b">put</a>, </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542abd269368d92362975c0ab1bb7b461813">deleteMethod</a> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string <a class="code" href="classhueplusplus_1_1_action.html#a258c2d4a88d5eed9dc85a2539fbcbd71">getAddress</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> <a class="code" href="classhueplusplus_1_1_action.html#a65f0cf2fb01397e023b1098aae2e8184">getMethod</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> nlohmann::json& <a class="code" href="classhueplusplus_1_1_action.html#a25e3761540d73055114b68c931353b72">getBody</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> nlohmann::json& <a class="code" href="classhueplusplus_1_1_action.html#a6de75285262d49b6ffb7edd4051cf6f3">toJson</a>() <span class="keyword">const</span>;</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="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> <a class="code" href="classhueplusplus_1_1_action.html#a51b50bd1b0b8dd3641a42218abb9f24e">parseMethod</a>(<span class="keyword">const</span> std::string& s);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> std::string <a class="code" href="classhueplusplus_1_1_action.html#a758c2ebb8875022fffca68c5b6a3c2d5">methodToString</a>(<a class="code" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> m);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  nlohmann::json json;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <span class="comment">// namespace hueplusplus</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classhueplusplus_1_1_action_html_a65f0cf2fb01397e023b1098aae2e8184"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a65f0cf2fb01397e023b1098aae2e8184">hueplusplus::Action::getMethod</a></div><div class="ttdeci">Method getMethod() const</div><div class="ttdoc">Get request method. </div><div class="ttdef"><b>Definition:</b> Action.cpp:35</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html"><div class="ttname"><a href="classhueplusplus_1_1_action.html">hueplusplus::Action</a></div><div class="ttdoc">Action executed by the bridge, e.g. as a Schedule command. </div><div class="ttdef"><b>Definition:</b> Action.h:35</div></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="classhueplusplus_1_1_action_html_a51b50bd1b0b8dd3641a42218abb9f24e"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a51b50bd1b0b8dd3641a42218abb9f24e">hueplusplus::Action::parseMethod</a></div><div class="ttdeci">static Method parseMethod(const std::string &s)</div><div class="ttdoc">Parse Method from string. </div><div class="ttdef"><b>Definition:</b> Action.cpp:50</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a6de75285262d49b6ffb7edd4051cf6f3"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a6de75285262d49b6ffb7edd4051cf6f3">hueplusplus::Action::toJson</a></div><div class="ttdeci">const nlohmann::json & toJson() const</div><div class="ttdoc">Get json object of command. </div><div class="ttdef"><b>Definition:</b> Action.cpp:45</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a2181208d0b6e26bdb84e594af85b1542abd269368d92362975c0ab1bb7b461813"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542abd269368d92362975c0ab1bb7b461813">hueplusplus::Action::Method::deleteMethod</a></div><div class="ttdoc">DELETE request. </div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a2181208d0b6e26bdb84e594af85b1542"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">hueplusplus::Action::Method</a></div><div class="ttdeci">Method</div><div class="ttdoc">Method used for the command. </div><div class="ttdef"><b>Definition:</b> Action.h:43</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a2181208d0b6e26bdb84e594af85b1542a8e13ffc9fd9d6a6761231a764bdf106b"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a8e13ffc9fd9d6a6761231a764bdf106b">hueplusplus::Action::Method::put</a></div><div class="ttdoc">PUT request. </div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a758c2ebb8875022fffca68c5b6a3c2d5"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a758c2ebb8875022fffca68c5b6a3c2d5">hueplusplus::Action::methodToString</a></div><div class="ttdeci">static std::string methodToString(Method m)</div><div class="ttdoc">Get string from Method. </div><div class="ttdef"><b>Definition:</b> Action.cpp:67</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a25e3761540d73055114b68c931353b72"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a25e3761540d73055114b68c931353b72">hueplusplus::Action::getBody</a></div><div class="ttdeci">const nlohmann::json & getBody() const</div><div class="ttdoc">Get request body. </div><div class="ttdef"><b>Definition:</b> Action.cpp:40</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a2181208d0b6e26bdb84e594af85b1542a42b90196b487c54069097a68fe98ab6f"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a42b90196b487c54069097a68fe98ab6f">hueplusplus::Action::Method::post</a></div><div class="ttdoc">POST request. </div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a258c2d4a88d5eed9dc85a2539fbcbd71"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a258c2d4a88d5eed9dc85a2539fbcbd71">hueplusplus::Action::getAddress</a></div><div class="ttdeci">std::string getAddress() const</div><div class="ttdoc">Get address the request is made to. </div><div class="ttdef"><b>Definition:</b> Action.cpp:30</div></div>
<div class="ttc" id="classhueplusplus_1_1_action_html_a581153171ecf44ce583e088c9bd6f048"><div class="ttname"><a href="classhueplusplus_1_1_action.html#a581153171ecf44ce583e088c9bd6f048">hueplusplus::Action::Action</a></div><div class="ttdeci">Action(const nlohmann::json &json)</div><div class="ttdoc">Create Action from json. </div><div class="ttdef"><b>Definition:</b> Action.cpp:28</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>