classhueplusplus_1_1_create_group.html
18.4 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!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::CreateGroup 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
 <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="classhueplusplus_1_1_create_group.html">CreateGroup</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classhueplusplus_1_1_create_group-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::CreateGroup Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parameters necessary for creating a new <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>.
<a href="classhueplusplus_1_1_create_group.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_group_8h_source.html">hueplusplus/Group.h</a>></code></p>
<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:a7a169bfa485cba4c262777f092a30628"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a7a169bfa485cba4c262777f092a30628">getRequest</a> () const</td></tr>
<tr class="memdesc:a7a169bfa485cba4c262777f092a30628"><td class="mdescLeft"> </td><td class="mdescRight">Get request to create the group. <a href="#a7a169bfa485cba4c262777f092a30628">More...</a><br /></td></tr>
<tr class="separator:a7a169bfa485cba4c262777f092a30628"><td class="memSeparator" colspan="2"> </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:a2da9c9bb8167e2a2e52076984289b415"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a2da9c9bb8167e2a2e52076984289b415">LightGroup</a> (const std::vector< int > &lights, const std::string &name="")</td></tr>
<tr class="memdesc:a2da9c9bb8167e2a2e52076984289b415"><td class="mdescLeft"> </td><td class="mdescRight">Create a LightGroup. <a href="#a2da9c9bb8167e2a2e52076984289b415">More...</a><br /></td></tr>
<tr class="separator:a2da9c9bb8167e2a2e52076984289b415"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bc9cdc0c77ba191ec8951047da15c95"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a8bc9cdc0c77ba191ec8951047da15c95">Room</a> (const std::vector< int > &lights, const std::string &name="", const std::string &roomType="")</td></tr>
<tr class="memdesc:a8bc9cdc0c77ba191ec8951047da15c95"><td class="mdescLeft"> </td><td class="mdescRight">Create a Room group. <a href="#a8bc9cdc0c77ba191ec8951047da15c95">More...</a><br /></td></tr>
<tr class="separator:a8bc9cdc0c77ba191ec8951047da15c95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b83c544258d31ec69d7b90515c41af9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a4b83c544258d31ec69d7b90515c41af9">Entertainment</a> (const std::vector< int > &lights, const std::string &name="")</td></tr>
<tr class="memdesc:a4b83c544258d31ec69d7b90515c41af9"><td class="mdescLeft"> </td><td class="mdescRight">Create an Entertainment group. <a href="#a4b83c544258d31ec69d7b90515c41af9">More...</a><br /></td></tr>
<tr class="separator:a4b83c544258d31ec69d7b90515c41af9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dacad456a494241755b3daeb5a8b390"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a5dacad456a494241755b3daeb5a8b390">Zone</a> (const std::vector< int > &lights, const std::string &name="")</td></tr>
<tr class="memdesc:a5dacad456a494241755b3daeb5a8b390"><td class="mdescLeft"> </td><td class="mdescRight">Create a Zone. <a href="#a5dacad456a494241755b3daeb5a8b390">More...</a><br /></td></tr>
<tr class="separator:a5dacad456a494241755b3daeb5a8b390"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a7bac7ddbadae0b264044a78fbdd09671"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_group.html#a7bac7ddbadae0b264044a78fbdd09671">CreateGroup</a> (const std::vector< int > &lights, const std::string &name, const std::string &type, const std::string &roomType)</td></tr>
<tr class="memdesc:a7bac7ddbadae0b264044a78fbdd09671"><td class="mdescLeft"> </td><td class="mdescRight">Protected constructor, should not be called directly. <a href="#a7bac7ddbadae0b264044a78fbdd09671">More...</a><br /></td></tr>
<tr class="separator:a7bac7ddbadae0b264044a78fbdd09671"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters necessary for creating a new <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>. </p>
<p>Provides static functions for each group type that can be created by the user. </p><dl class="section note"><dt>Note</dt><dd>These are not all types that <a class="el" href="classhueplusplus_1_1_group.html#a5325969d0445adee1f5d3430e71d5168" title="Get the group type. ">Group::getType()</a> can return, because some types cannot be created manually. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7bac7ddbadae0b264044a78fbdd09671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bac7ddbadae0b264044a78fbdd09671">◆ </a></span>CreateGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::CreateGroup::CreateGroup </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>lights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>roomType</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected constructor, should not be called directly. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lights</td><td>List of light ids for the group. </td></tr>
<tr><td class="paramname">name</td><td>Name of the group, empty for default name. </td></tr>
<tr><td class="paramname">type</td><td>Type of the group, empty for default type. </td></tr>
<tr><td class="paramname">roomType</td><td>Room class if type is room, empty for default class or if type is not room. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4b83c544258d31ec69d7b90515c41af9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b83c544258d31ec69d7b90515c41af9">◆ </a></span>Entertainment()</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_1_create_group.html">CreateGroup</a> hueplusplus::CreateGroup::Entertainment </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>lights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Create an Entertainment group. </p>
<p>The lights are used in an entertainment setup and can have relative positions. The group can be empty. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lights</td><td>List of light ids, may be empty. </td></tr>
<tr><td class="paramname">name</td><td>Name of the group, optional. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7a169bfa485cba4c262777f092a30628"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a169bfa485cba4c262777f092a30628">◆ </a></span>getRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::CreateGroup::getRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request to create the group. </p>
<dl class="section return"><dt>Returns</dt><dd>JSON request for a POST to create the new group </dd></dl>
</div>
</div>
<a id="a2da9c9bb8167e2a2e52076984289b415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da9c9bb8167e2a2e52076984289b415">◆ </a></span>LightGroup()</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_1_create_group.html">CreateGroup</a> hueplusplus::CreateGroup::LightGroup </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>lights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Create a LightGroup. </p>
<p>LightGroup is the default type for groups. Empty LightGroups will be deleted. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lights</td><td>List of light ids, must not be empty. </td></tr>
<tr><td class="paramname">name</td><td>Name of the new group, optional. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8bc9cdc0c77ba191ec8951047da15c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bc9cdc0c77ba191ec8951047da15c95">◆ </a></span>Room()</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_1_create_group.html">CreateGroup</a> hueplusplus::CreateGroup::Room </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>lights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>roomType</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Create a Room group. </p>
<p>Rooms can have a room class and can be empty. Every light can only be in one room. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lights</td><td>List of light ids, may be empty. </td></tr>
<tr><td class="paramname">name</td><td>Name of the room, optional. </td></tr>
<tr><td class="paramname">roomType</td><td>Class of the room (case sensitive), optional. Refer to Hue developer documentation for a list of possible room classes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5dacad456a494241755b3daeb5a8b390"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dacad456a494241755b3daeb5a8b390">◆ </a></span>Zone()</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_1_create_group.html">CreateGroup</a> hueplusplus::CreateGroup::Zone </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>lights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Create a Zone. </p>
<p>Zones can be empty, a light can be in multiple zones. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lights</td><td>List of light ids, may be empty. </td></tr>
<tr><td class="paramname">name</td><td>Name of the Zone, optional. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_group_8h_source.html">Group.h</a></li>
<li>src/<a class="el" href="_group_8cpp.html">Group.cpp</a></li>
</ul>
</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>