classhueplusplus_1_1_group.html
79.7 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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
<!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::Group 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_group.html">Group</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classhueplusplus_1_1_group-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::Group Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class for Groups of lights.
<a href="classhueplusplus_1_1_group.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_group_8h_source.html">hueplusplus/Group.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for hueplusplus::Group:</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="classhueplusplus_1_1_group__coll__graph.png" border="0" usemap="#hueplusplus_1_1_group_coll__map" alt="Collaboration graph"/></div>
<map name="hueplusplus_1_1_group_coll__map" id="hueplusplus_1_1_group_coll__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. " alt="" coords="5,5,175,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a32be75ce66d601190d41825ebdf1e0f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a32be75ce66d601190d41825ebdf1e0f4">Group</a> (int <a class="el" href="classhueplusplus_1_1_group.html#a31395d0cf493a03eceebf87e634a93ea">id</a>, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &baseCache)</td></tr>
<tr class="memdesc:a32be75ce66d601190d41825ebdf1e0f4"><td class="mdescLeft"> </td><td class="mdescRight">Creates group with shared cache. <a href="#a32be75ce66d601190d41825ebdf1e0f4">More...</a><br /></td></tr>
<tr class="separator:a32be75ce66d601190d41825ebdf1e0f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57ba3b0950a70a069867f56d6bdc7cc9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a57ba3b0950a70a069867f56d6bdc7cc9">Group</a> (int <a class="el" href="classhueplusplus_1_1_group.html#a31395d0cf493a03eceebf87e634a93ea">id</a>, const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> &commands, std::chrono::steady_clock::duration refreshDuration, const nlohmann::json &currentState)</td></tr>
<tr class="memdesc:a57ba3b0950a70a069867f56d6bdc7cc9"><td class="mdescLeft"> </td><td class="mdescRight">Creates group with id. <a href="#a57ba3b0950a70a069867f56d6bdc7cc9">More...</a><br /></td></tr>
<tr class="separator:a57ba3b0950a70a069867f56d6bdc7cc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9acdde574461a8891cb4a5c74d740d8c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a9acdde574461a8891cb4a5c74d740d8c">refresh</a> (bool force=false)</td></tr>
<tr class="memdesc:a9acdde574461a8891cb4a5c74d740d8c"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes internal cached state. <a href="#a9acdde574461a8891cb4a5c74d740d8c">More...</a><br /></td></tr>
<tr class="separator:a9acdde574461a8891cb4a5c74d740d8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45a76c0ae84080f4b6c0ca9c261f1774"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a45a76c0ae84080f4b6c0ca9c261f1774">setRefreshDuration</a> (std::chrono::steady_clock::duration refreshDuration)</td></tr>
<tr class="memdesc:a45a76c0ae84080f4b6c0ca9c261f1774"><td class="mdescLeft"> </td><td class="mdescRight">Sets custom refresh interval for this group. <a href="#a45a76c0ae84080f4b6c0ca9c261f1774">More...</a><br /></td></tr>
<tr class="separator:a45a76c0ae84080f4b6c0ca9c261f1774"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">General information</div></td></tr>
<tr class="memitem:a3fd91f063daafd0b8489da895933633d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a3fd91f063daafd0b8489da895933633d">getId</a> () const</td></tr>
<tr class="memdesc:a3fd91f063daafd0b8489da895933633d"><td class="mdescLeft"> </td><td class="mdescRight">Get the group id. <a href="#a3fd91f063daafd0b8489da895933633d">More...</a><br /></td></tr>
<tr class="separator:a3fd91f063daafd0b8489da895933633d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedac57e05d40c976c92d58bd05709ccf"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#aedac57e05d40c976c92d58bd05709ccf">getName</a> () const</td></tr>
<tr class="memdesc:aedac57e05d40c976c92d58bd05709ccf"><td class="mdescLeft"> </td><td class="mdescRight">Get the group name. <a href="#aedac57e05d40c976c92d58bd05709ccf">More...</a><br /></td></tr>
<tr class="separator:aedac57e05d40c976c92d58bd05709ccf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5325969d0445adee1f5d3430e71d5168"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a5325969d0445adee1f5d3430e71d5168">getType</a> () const</td></tr>
<tr class="memdesc:a5325969d0445adee1f5d3430e71d5168"><td class="mdescLeft"> </td><td class="mdescRight">Get the group type. <a href="#a5325969d0445adee1f5d3430e71d5168">More...</a><br /></td></tr>
<tr class="separator:a5325969d0445adee1f5d3430e71d5168"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8c8fa5b3f2bc2212c400bc1959769dd"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#ad8c8fa5b3f2bc2212c400bc1959769dd">getLightIds</a> () const</td></tr>
<tr class="memdesc:ad8c8fa5b3f2bc2212c400bc1959769dd"><td class="mdescLeft"> </td><td class="mdescRight">Get lights in the group. <a href="#ad8c8fa5b3f2bc2212c400bc1959769dd">More...</a><br /></td></tr>
<tr class="separator:ad8c8fa5b3f2bc2212c400bc1959769dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e9d4d67e5ff409212c13de11c8ebec5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a9e9d4d67e5ff409212c13de11c8ebec5">setName</a> (const std::string &name)</td></tr>
<tr class="memdesc:a9e9d4d67e5ff409212c13de11c8ebec5"><td class="mdescLeft"> </td><td class="mdescRight">Set group name. <a href="#a9e9d4d67e5ff409212c13de11c8ebec5">More...</a><br /></td></tr>
<tr class="separator:a9e9d4d67e5ff409212c13de11c8ebec5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a559ea3f638f57a3bd78631c750cbf0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a3a559ea3f638f57a3bd78631c750cbf0">setLights</a> (const std::vector< int > &ids)</td></tr>
<tr class="memdesc:a3a559ea3f638f57a3bd78631c750cbf0"><td class="mdescLeft"> </td><td class="mdescRight">Set group lights. <a href="#a3a559ea3f638f57a3bd78631c750cbf0">More...</a><br /></td></tr>
<tr class="separator:a3a559ea3f638f57a3bd78631c750cbf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a987a9cc346d7ea454aac54a8430dda99"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a987a9cc346d7ea454aac54a8430dda99">getRoomType</a> () const</td></tr>
<tr class="memdesc:a987a9cc346d7ea454aac54a8430dda99"><td class="mdescLeft"> </td><td class="mdescRight">Get room type, only for type room. <a href="#a987a9cc346d7ea454aac54a8430dda99">More...</a><br /></td></tr>
<tr class="separator:a987a9cc346d7ea454aac54a8430dda99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4a2c109ea2f0da10e5054d0c6d0c5e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#af4a2c109ea2f0da10e5054d0c6d0c5e7">setRoomType</a> (const std::string &type)</td></tr>
<tr class="memdesc:af4a2c109ea2f0da10e5054d0c6d0c5e7"><td class="mdescLeft"> </td><td class="mdescRight">Set room type, only for type room. <a href="#af4a2c109ea2f0da10e5054d0c6d0c5e7">More...</a><br /></td></tr>
<tr class="separator:af4a2c109ea2f0da10e5054d0c6d0c5e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81336c603e9ee8f775cbdef180eb029c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a81336c603e9ee8f775cbdef180eb029c">getModelId</a> () const</td></tr>
<tr class="memdesc:a81336c603e9ee8f775cbdef180eb029c"><td class="mdescLeft"> </td><td class="mdescRight">Get luminaire model id, only for type luminaire. <a href="#a81336c603e9ee8f775cbdef180eb029c">More...</a><br /></td></tr>
<tr class="separator:a81336c603e9ee8f775cbdef180eb029c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b8d9c14f767c78d248a6d3dab1e6a6a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a7b8d9c14f767c78d248a6d3dab1e6a6a">getUniqueId</a> () const</td></tr>
<tr class="memdesc:a7b8d9c14f767c78d248a6d3dab1e6a6a"><td class="mdescLeft"> </td><td class="mdescRight">Get luminaire model id, only for type luminaire or lightsource. <a href="#a7b8d9c14f767c78d248a6d3dab1e6a6a">More...</a><br /></td></tr>
<tr class="separator:a7b8d9c14f767c78d248a6d3dab1e6a6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2afaf3ff50700dfa9f86f33da7d26924"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a2afaf3ff50700dfa9f86f33da7d26924">getAllOn</a> ()</td></tr>
<tr class="memdesc:a2afaf3ff50700dfa9f86f33da7d26924"><td class="mdescLeft"> </td><td class="mdescRight">Get whether all lights are on. <a href="#a2afaf3ff50700dfa9f86f33da7d26924">More...</a><br /></td></tr>
<tr class="separator:a2afaf3ff50700dfa9f86f33da7d26924"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5531d2638f445fc01ee283f37dd3fb9e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a5531d2638f445fc01ee283f37dd3fb9e">getAllOn</a> () const</td></tr>
<tr class="memdesc:a5531d2638f445fc01ee283f37dd3fb9e"><td class="mdescLeft"> </td><td class="mdescRight">Get whether all lights are on. <a href="#a5531d2638f445fc01ee283f37dd3fb9e">More...</a><br /></td></tr>
<tr class="separator:a5531d2638f445fc01ee283f37dd3fb9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56c238a0be5ec2c4966bac3a0cf872c5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a56c238a0be5ec2c4966bac3a0cf872c5">getAnyOn</a> ()</td></tr>
<tr class="memdesc:a56c238a0be5ec2c4966bac3a0cf872c5"><td class="mdescLeft"> </td><td class="mdescRight">Get whether any light is on. <a href="#a56c238a0be5ec2c4966bac3a0cf872c5">More...</a><br /></td></tr>
<tr class="separator:a56c238a0be5ec2c4966bac3a0cf872c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba6ad6c4eaacfd8de07aa19cdc91e6bf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#aba6ad6c4eaacfd8de07aa19cdc91e6bf">getAnyOn</a> () const</td></tr>
<tr class="memdesc:aba6ad6c4eaacfd8de07aa19cdc91e6bf"><td class="mdescLeft"> </td><td class="mdescRight">Get whether any light is on. <a href="#aba6ad6c4eaacfd8de07aa19cdc91e6bf">More...</a><br /></td></tr>
<tr class="separator:aba6ad6c4eaacfd8de07aa19cdc91e6bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Query Action</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The action is the state of one light in the group. It can be accessed using these methods. </p>
</div></td></tr>
<tr class="memitem:a817792ccaa71be19c9d64415c8415f4d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a817792ccaa71be19c9d64415c8415f4d">getActionOn</a> ()</td></tr>
<tr class="memdesc:a817792ccaa71be19c9d64415c8415f4d"><td class="mdescLeft"> </td><td class="mdescRight">Get on state of one light in the group. <a href="#a817792ccaa71be19c9d64415c8415f4d">More...</a><br /></td></tr>
<tr class="separator:a817792ccaa71be19c9d64415c8415f4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b4189da2f630035f98950174f442123"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a0b4189da2f630035f98950174f442123">getActionOn</a> () const</td></tr>
<tr class="memdesc:a0b4189da2f630035f98950174f442123"><td class="mdescLeft"> </td><td class="mdescRight">Get on state of one light in the group. <a href="#a0b4189da2f630035f98950174f442123">More...</a><br /></td></tr>
<tr class="separator:a0b4189da2f630035f98950174f442123"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae46361ffec4f0103f257d04b582b136a"><td class="memItemLeft" align="right" valign="top">std::pair< uint16_t, uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#ae46361ffec4f0103f257d04b582b136a">getActionHueSaturation</a> ()</td></tr>
<tr class="memdesc:ae46361ffec4f0103f257d04b582b136a"><td class="mdescLeft"> </td><td class="mdescRight">Get hue and saturation of one light in the group. <a href="#ae46361ffec4f0103f257d04b582b136a">More...</a><br /></td></tr>
<tr class="separator:ae46361ffec4f0103f257d04b582b136a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a411f3566414105e139e32f91a9c0040b"><td class="memItemLeft" align="right" valign="top">std::pair< uint16_t, uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a411f3566414105e139e32f91a9c0040b">getActionHueSaturation</a> () const</td></tr>
<tr class="memdesc:a411f3566414105e139e32f91a9c0040b"><td class="mdescLeft"> </td><td class="mdescRight">Get hue and saturation of one light in the group. <a href="#a411f3566414105e139e32f91a9c0040b">More...</a><br /></td></tr>
<tr class="separator:a411f3566414105e139e32f91a9c0040b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33472d243016526df7cca8a53a087894"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a33472d243016526df7cca8a53a087894">getActionBrightness</a> ()</td></tr>
<tr class="memdesc:a33472d243016526df7cca8a53a087894"><td class="mdescLeft"> </td><td class="mdescRight">Get brightness of one light in the group. <a href="#a33472d243016526df7cca8a53a087894">More...</a><br /></td></tr>
<tr class="separator:a33472d243016526df7cca8a53a087894"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0935ac3407b4242faf32fa74d6b1273a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a0935ac3407b4242faf32fa74d6b1273a">getActionBrightness</a> () const</td></tr>
<tr class="memdesc:a0935ac3407b4242faf32fa74d6b1273a"><td class="mdescLeft"> </td><td class="mdescRight">Get brightness of one light in the group. <a href="#a0935ac3407b4242faf32fa74d6b1273a">More...</a><br /></td></tr>
<tr class="separator:a0935ac3407b4242faf32fa74d6b1273a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5faa9eba8b9d932c0d1bb1e4ff6e3d68"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a5faa9eba8b9d932c0d1bb1e4ff6e3d68">getActionColorTemperature</a> ()</td></tr>
<tr class="memdesc:a5faa9eba8b9d932c0d1bb1e4ff6e3d68"><td class="mdescLeft"> </td><td class="mdescRight">Get color temperature of one light in the group. <a href="#a5faa9eba8b9d932c0d1bb1e4ff6e3d68">More...</a><br /></td></tr>
<tr class="separator:a5faa9eba8b9d932c0d1bb1e4ff6e3d68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae158416211315055594e47c47cf02254"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#ae158416211315055594e47c47cf02254">getActionColorTemperature</a> () const</td></tr>
<tr class="memdesc:ae158416211315055594e47c47cf02254"><td class="mdescLeft"> </td><td class="mdescRight">Get color temperature of one light in the group. <a href="#ae158416211315055594e47c47cf02254">More...</a><br /></td></tr>
<tr class="separator:ae158416211315055594e47c47cf02254"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bc1464d7a85a3f3315233c11fbdcc90"><td class="memItemLeft" align="right" valign="top">std::pair< float, float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a2bc1464d7a85a3f3315233c11fbdcc90">getActionColorXY</a> ()</td></tr>
<tr class="memdesc:a2bc1464d7a85a3f3315233c11fbdcc90"><td class="mdescLeft"> </td><td class="mdescRight">Get color coordinates of one light in the group. <a href="#a2bc1464d7a85a3f3315233c11fbdcc90">More...</a><br /></td></tr>
<tr class="separator:a2bc1464d7a85a3f3315233c11fbdcc90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac0ffc91d023824abcbfd189f336a969"><td class="memItemLeft" align="right" valign="top">std::pair< float, float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#aac0ffc91d023824abcbfd189f336a969">getActionColorXY</a> () const</td></tr>
<tr class="memdesc:aac0ffc91d023824abcbfd189f336a969"><td class="mdescLeft"> </td><td class="mdescRight">Get color coordinates of one light in the group. <a href="#aac0ffc91d023824abcbfd189f336a969">More...</a><br /></td></tr>
<tr class="separator:aac0ffc91d023824abcbfd189f336a969"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdfb33e00d24c9b2659e9625300b040f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#afdfb33e00d24c9b2659e9625300b040f">getActionColorMode</a> ()</td></tr>
<tr class="memdesc:afdfb33e00d24c9b2659e9625300b040f"><td class="mdescLeft"> </td><td class="mdescRight">Get color mode of one light in the group. <a href="#afdfb33e00d24c9b2659e9625300b040f">More...</a><br /></td></tr>
<tr class="separator:afdfb33e00d24c9b2659e9625300b040f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cd1ab29daa6c6eda78568b18373a8da"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a3cd1ab29daa6c6eda78568b18373a8da">getActionColorMode</a> () const</td></tr>
<tr class="memdesc:a3cd1ab29daa6c6eda78568b18373a8da"><td class="mdescLeft"> </td><td class="mdescRight">Get color mode of one light in the group. <a href="#a3cd1ab29daa6c6eda78568b18373a8da">More...</a><br /></td></tr>
<tr class="separator:a3cd1ab29daa6c6eda78568b18373a8da"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Change lights</div></td></tr>
<tr class="memitem:a0cbbc12721df742db97eb824a9356384"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_state_transaction.html">StateTransaction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a0cbbc12721df742db97eb824a9356384">transaction</a> ()</td></tr>
<tr class="memdesc:a0cbbc12721df742db97eb824a9356384"><td class="mdescLeft"> </td><td class="mdescRight">Create a transaction for this group. <a href="#a0cbbc12721df742db97eb824a9356384">More...</a><br /></td></tr>
<tr class="separator:a0cbbc12721df742db97eb824a9356384"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acba209f24f41a55af7fc7669150377a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#acba209f24f41a55af7fc7669150377a9">setOn</a> (bool on, uint8_t transition=4)</td></tr>
<tr class="memdesc:acba209f24f41a55af7fc7669150377a9"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to turn lights on. <a href="#acba209f24f41a55af7fc7669150377a9">More...</a><br /></td></tr>
<tr class="separator:acba209f24f41a55af7fc7669150377a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed3c72903baccbc80e206a2fb8e10594"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#aed3c72903baccbc80e206a2fb8e10594">setBrightness</a> (uint8_t brightness, uint8_t transition=4)</td></tr>
<tr class="memdesc:aed3c72903baccbc80e206a2fb8e10594"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to set brightness. <a href="#aed3c72903baccbc80e206a2fb8e10594">More...</a><br /></td></tr>
<tr class="separator:aed3c72903baccbc80e206a2fb8e10594"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1926d36649f120a4a688de6c94feb33e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a1926d36649f120a4a688de6c94feb33e">setColor</a> (const <a class="el" href="structhueplusplus_1_1_hue_saturation.html">HueSaturation</a> &hueSat, uint8_t transition=4)</td></tr>
<tr class="memdesc:a1926d36649f120a4a688de6c94feb33e"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to set hue and saturation. <a href="#a1926d36649f120a4a688de6c94feb33e">More...</a><br /></td></tr>
<tr class="separator:a1926d36649f120a4a688de6c94feb33e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b36c6ddc60844a61f2edfe63da6cf26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a2b36c6ddc60844a61f2edfe63da6cf26">setColor</a> (const <a class="el" href="structhueplusplus_1_1_x_y_brightness.html">XYBrightness</a> &xy, uint8_t transition=4)</td></tr>
<tr class="memdesc:a2b36c6ddc60844a61f2edfe63da6cf26"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to set color xy. <a href="#a2b36c6ddc60844a61f2edfe63da6cf26">More...</a><br /></td></tr>
<tr class="separator:a2b36c6ddc60844a61f2edfe63da6cf26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae6193c2db9a9d3dfd2f83cf978966c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#aae6193c2db9a9d3dfd2f83cf978966c3">setColorTemperature</a> (unsigned int mired, uint8_t transition=4)</td></tr>
<tr class="memdesc:aae6193c2db9a9d3dfd2f83cf978966c3"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to set color temperature. <a href="#aae6193c2db9a9d3dfd2f83cf978966c3">More...</a><br /></td></tr>
<tr class="separator:aae6193c2db9a9d3dfd2f83cf978966c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3975e456a1db2b89e35e521069244fce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a3975e456a1db2b89e35e521069244fce">setColorLoop</a> (bool on, uint8_t transition=4)</td></tr>
<tr class="memdesc:a3975e456a1db2b89e35e521069244fce"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to set color loop. <a href="#a3975e456a1db2b89e35e521069244fce">More...</a><br /></td></tr>
<tr class="separator:a3975e456a1db2b89e35e521069244fce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9cf05320f7ead132a60b89b6ec7559a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a9cf05320f7ead132a60b89b6ec7559a4">setScene</a> (const std::string &scene)</td></tr>
<tr class="memdesc:a9cf05320f7ead132a60b89b6ec7559a4"><td class="mdescLeft"> </td><td class="mdescRight">Recall scene for the group. <a href="#a9cf05320f7ead132a60b89b6ec7559a4">More...</a><br /></td></tr>
<tr class="separator:a9cf05320f7ead132a60b89b6ec7559a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d645f29b34270c4557db3594dc3593a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_action.html">Action</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a3d645f29b34270c4557db3594dc3593a">createSceneAction</a> (const std::string &scene) const</td></tr>
<tr class="memdesc:a3d645f29b34270c4557db3594dc3593a"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> to set scene. <a href="#a3d645f29b34270c4557db3594dc3593a">More...</a><br /></td></tr>
<tr class="separator:a3d645f29b34270c4557db3594dc3593a"><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:a5910d8ce68581f45297e902a21ebc55d"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a5910d8ce68581f45297e902a21ebc55d">sendPutRequest</a> (const std::string &subPath, const nlohmann::json &request, <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo)</td></tr>
<tr class="memdesc:a5910d8ce68581f45297e902a21ebc55d"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to send a put request to the group. <a href="#a5910d8ce68581f45297e902a21ebc55d">More...</a><br /></td></tr>
<tr class="separator:a5910d8ce68581f45297e902a21ebc55d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a31395d0cf493a03eceebf87e634a93ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a31395d0cf493a03eceebf87e634a93ea">id</a></td></tr>
<tr class="separator:a31395d0cf493a03eceebf87e634a93ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2043d08dd6a4d94efd6497e5d3ebe202"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_group.html#a2043d08dd6a4d94efd6497e5d3ebe202">state</a></td></tr>
<tr class="separator:a2043d08dd6a4d94efd6497e5d3ebe202"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for Groups of lights. </p>
<p>Provides methods to control groups. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a32be75ce66d601190d41825ebdf1e0f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32be75ce66d601190d41825ebdf1e0f4">◆ </a></span>Group() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::Group::Group </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > & </td>
<td class="paramname"><em>baseCache</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates group with shared cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td><a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a> id in the bridge </td></tr>
<tr><td class="paramname">baseCache</td><td>Cache of the group list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a57ba3b0950a70a069867f56d6bdc7cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57ba3b0950a70a069867f56d6bdc7cc9">◆ </a></span>Group() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::Group::Group </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & </td>
<td class="paramname"><em>commands</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>currentState</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates group with id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td><a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a> id in the bridge </td></tr>
<tr><td class="paramname">commands</td><td><a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> for requests </td></tr>
<tr><td class="paramname">refreshDuration</td><td>Time between refreshing the cached state. </td></tr>
<tr><td class="paramname">currentState</td><td>The current state, may be null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3d645f29b34270c4557db3594dc3593a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d645f29b34270c4557db3594dc3593a">◆ </a></span>createSceneAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_action.html">Action</a> hueplusplus::Group::createSceneAction </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>scene</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> to set scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scene</td><td><a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a> name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> that can be used to set the scene on a <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a></dd></dl>
<p>To set other light properties in a scene, use <a class="el" href="classhueplusplus_1_1_group.html#a0cbbc12721df742db97eb824a9356384" title="Create a transaction for this group. ">transaction()</a>. </p>
</div>
</div>
<a id="a33472d243016526df7cca8a53a087894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33472d243016526df7cca8a53a087894">◆ </a></span>getActionBrightness() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int hueplusplus::Group::getActionBrightness </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get brightness of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Brightness (0-254). </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0935ac3407b4242faf32fa74d6b1273a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0935ac3407b4242faf32fa74d6b1273a">◆ </a></span>getActionBrightness() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int hueplusplus::Group::getActionBrightness </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get brightness of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Brightness (0-254). </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="afdfb33e00d24c9b2659e9625300b040f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdfb33e00d24c9b2659e9625300b040f">◆ </a></span>getActionColorMode() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getActionColorMode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color mode of one light in the group. </p>
<p>The color mode is the currently used way to specify the color (hs,ct or xy). </p><dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3cd1ab29daa6c6eda78568b18373a8da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cd1ab29daa6c6eda78568b18373a8da">◆ </a></span>getActionColorMode() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getActionColorMode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color mode of one light in the group. </p>
<p>The color mode is the currently used way to specify the color (hs,ct or xy). </p><dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a5faa9eba8b9d932c0d1bb1e4ff6e3d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5faa9eba8b9d932c0d1bb1e4ff6e3d68">◆ </a></span>getActionColorTemperature() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int hueplusplus::Group::getActionColorTemperature </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color temperature of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Color temperature in mired. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae158416211315055594e47c47cf02254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae158416211315055594e47c47cf02254">◆ </a></span>getActionColorTemperature() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int hueplusplus::Group::getActionColorTemperature </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color temperature of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Color temperature in mired. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a2bc1464d7a85a3f3315233c11fbdcc90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bc1464d7a85a3f3315233c11fbdcc90">◆ </a></span>getActionColorXY() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::pair< float, float > hueplusplus::Group::getActionColorXY </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color coordinates of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Pair of x and y color coordinates. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac0ffc91d023824abcbfd189f336a969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac0ffc91d023824abcbfd189f336a969">◆ </a></span>getActionColorXY() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::pair< float, float > hueplusplus::Group::getActionColorXY </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get color coordinates of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Pair of x and y color coordinates. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="ae46361ffec4f0103f257d04b582b136a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae46361ffec4f0103f257d04b582b136a">◆ </a></span>getActionHueSaturation() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::pair< uint16_t, uint8_t > hueplusplus::Group::getActionHueSaturation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get hue and saturation of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Pair of hue, saturation. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a411f3566414105e139e32f91a9c0040b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a411f3566414105e139e32f91a9c0040b">◆ </a></span>getActionHueSaturation() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::pair< uint16_t, uint8_t > hueplusplus::Group::getActionHueSaturation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get hue and saturation of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Pair of hue, saturation. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a817792ccaa71be19c9d64415c8415f4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a817792ccaa71be19c9d64415c8415f4d">◆ </a></span>getActionOn() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getActionOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get on state of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the light is on. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0b4189da2f630035f98950174f442123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b4189da2f630035f98950174f442123">◆ </a></span>getActionOn() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getActionOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get on state of one light in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the light is on. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a2afaf3ff50700dfa9f86f33da7d26924"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2afaf3ff50700dfa9f86f33da7d26924">◆ </a></span>getAllOn() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getAllOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get whether all lights are on. </p>
<dl class="section return"><dt>Returns</dt><dd>true when all lights are on. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5531d2638f445fc01ee283f37dd3fb9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5531d2638f445fc01ee283f37dd3fb9e">◆ </a></span>getAllOn() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getAllOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get whether all lights are on. </p>
<dl class="section return"><dt>Returns</dt><dd>true when all lights are on. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a56c238a0be5ec2c4966bac3a0cf872c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56c238a0be5ec2c4966bac3a0cf872c5">◆ </a></span>getAnyOn() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getAnyOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get whether any light is on. </p>
<dl class="section return"><dt>Returns</dt><dd>true when any light is on. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aba6ad6c4eaacfd8de07aa19cdc91e6bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba6ad6c4eaacfd8de07aa19cdc91e6bf">◆ </a></span>getAnyOn() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Group::getAnyOn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get whether any light is on. </p>
<dl class="section return"><dt>Returns</dt><dd>true when any light is on. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Does not refresh the state. </dd></dl>
</div>
</div>
<a id="a3fd91f063daafd0b8489da895933633d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fd91f063daafd0b8489da895933633d">◆ </a></span>getId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::Group::getId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the group id. </p>
</div>
</div>
<a id="ad8c8fa5b3f2bc2212c400bc1959769dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8c8fa5b3f2bc2212c400bc1959769dd">◆ </a></span>getLightIds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< int > hueplusplus::Group::getLightIds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get lights in the group. </p>
<dl class="section return"><dt>Returns</dt><dd>Ids of the lights in the group. </dd></dl>
</div>
</div>
<a id="a81336c603e9ee8f775cbdef180eb029c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81336c603e9ee8f775cbdef180eb029c">◆ </a></span>getModelId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getModelId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get luminaire model id, only for type luminaire. </p>
<dl class="section return"><dt>Returns</dt><dd>Unique id for the hardware model. </dd></dl>
</div>
</div>
<a id="aedac57e05d40c976c92d58bd05709ccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedac57e05d40c976c92d58bd05709ccf">◆ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the group name. </p>
</div>
</div>
<a id="a987a9cc346d7ea454aac54a8430dda99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a987a9cc346d7ea454aac54a8430dda99">◆ </a></span>getRoomType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getRoomType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get room type, only for type room. </p>
<dl class="section return"><dt>Returns</dt><dd>Room type/class of the group. </dd></dl>
</div>
</div>
<a id="a5325969d0445adee1f5d3430e71d5168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5325969d0445adee1f5d3430e71d5168">◆ </a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the group type. </p>
<p>The type is specified on creation and cannot be changed.</p>
<p>Possible types: </p><ul>
<li><code>0</code>: Special group containing all lights, cannot be modified. </li>
<li><code>Luminaire</code>, <code>Lightsource</code>: Automatically created groups for multisource luminaires. </li>
<li><code>LightGroup</code>: Standard, user created group, not empty. </li>
<li><code>Room</code>: User created room, has room type. </li>
<li><code>Entertainment</code>: User created entertainment setup. </li>
<li><code>Zone</code>: User created Zone. </li>
</ul>
</div>
</div>
<a id="a7b8d9c14f767c78d248a6d3dab1e6a6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b8d9c14f767c78d248a6d3dab1e6a6a">◆ </a></span>getUniqueId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Group::getUniqueId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get luminaire model id, only for type luminaire or lightsource. </p>
<dl class="section return"><dt>Returns</dt><dd>Unique id in <code>AA:BB:CC:DD</code> format for luminaire groups or <code>AA:BB:CC:DD-XX</code> for Lightsource groups. </dd></dl>
</div>
</div>
<a id="a9acdde574461a8891cb4a5c74d740d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9acdde574461a8891cb4a5c74d740d8c">◆ </a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::refresh </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes internal cached state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">force</td><td><code>true</code> forces a refresh, regardless of how long the last refresh was ago. <code>false</code> to only refresh when enough time has passed (needed e.g. when calling only const methods). </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5910d8ce68581f45297e902a21ebc55d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5910d8ce68581f45297e902a21ebc55d">◆ </a></span>sendPutRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::Group::sendPutRequest </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>subPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> </td>
<td class="paramname"><em>fileInfo</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>Utility function to send a put request to the group. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request to send </td></tr>
<tr><td class="paramname">subPath</td><td>A path that is appended to the uri, note it should always start with a slash ("/") </td></tr>
<tr><td class="paramname">fileInfo</td><td><a class="el" href="structhueplusplus_1_1_file_info.html" title="Contains information about error location, use CURRENT_FILE_INFO to create. ">FileInfo</a> from calling function for exception details. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The parsed reply </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aed3c72903baccbc80e206a2fb8e10594"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed3c72903baccbc80e206a2fb8e10594">◆ </a></span>setBrightness()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setBrightness </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>brightness</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to set brightness. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#a3502aed5c5b47f058133358959c171e5" title="Set light brightness. ">StateTransaction::setBrightness</a> </dd></dl>
</div>
</div>
<a id="a1926d36649f120a4a688de6c94feb33e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1926d36649f120a4a688de6c94feb33e">◆ </a></span>setColor() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setColor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structhueplusplus_1_1_hue_saturation.html">HueSaturation</a> & </td>
<td class="paramname"><em>hueSat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to set hue and saturation. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#aedc15504da306e334f4da5218cc5a638" title="Set light color in hue and saturation. ">StateTransaction::setColor(const HueSaturation&)</a> </dd></dl>
</div>
</div>
<a id="a2b36c6ddc60844a61f2edfe63da6cf26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b36c6ddc60844a61f2edfe63da6cf26">◆ </a></span>setColor() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setColor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structhueplusplus_1_1_x_y_brightness.html">XYBrightness</a> & </td>
<td class="paramname"><em>xy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to set color xy. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#a95d83694839ed7efcef42cf1c3649a46" title="Set light color and brightness in xy space. ">StateTransaction::setColor(const XYBrightness&)</a> </dd></dl>
</div>
</div>
<a id="a3975e456a1db2b89e35e521069244fce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3975e456a1db2b89e35e521069244fce">◆ </a></span>setColorLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setColorLoop </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to set color loop. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#a61daf0b474ba175cfbd09f849bee90bb" title="Enables or disables color loop. ">StateTransaction::setColorLoop</a> </dd></dl>
</div>
</div>
<a id="aae6193c2db9a9d3dfd2f83cf978966c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae6193c2db9a9d3dfd2f83cf978966c3">◆ </a></span>setColorTemperature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setColorTemperature </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>mired</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to set color temperature. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#ab4baed74a081d9c238830a301b93b265" title="Set light color temperature. ">StateTransaction::setColorTemperature</a> </dd></dl>
</div>
</div>
<a id="a3a559ea3f638f57a3bd78631c750cbf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a559ea3f638f57a3bd78631c750cbf0">◆ </a></span>setLights()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setLights </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>ids</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set group lights. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ids</td><td>New light ids. May or may not be empty depending on type. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9e9d4d67e5ff409212c13de11c8ebec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e9d4d67e5ff409212c13de11c8ebec5">◆ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set group name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>New name for the group. Must be unique for all groups, otherwise a number is added. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acba209f24f41a55af7fc7669150377a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acba209f24f41a55af7fc7669150377a9">◆ </a></span>setOn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setOn </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>transition</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to turn lights on. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_state_transaction.html#a1627d0ca2714a6c24e5e1c7b9647bd70" title="Turn light on or off. ">StateTransaction::setOn</a> </dd></dl>
</div>
</div>
<a id="a45a76c0ae84080f4b6c0ca9c261f1774"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a76c0ae84080f4b6c0ca9c261f1774">◆ </a></span>setRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setRefreshDuration </td>
<td>(</td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets custom refresh interval for this group. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refreshDuration</td><td>The new minimum duration between refreshes. May be 0 or <a class="el" href="namespacehueplusplus.html#add9e010e3277f7763db4006cc9f46b86">c_refreshNever</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af4a2c109ea2f0da10e5054d0c6d0c5e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4a2c109ea2f0da10e5054d0c6d0c5e7">◆ </a></span>setRoomType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setRoomType </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set room type, only for type room. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>New room class, case sensitive. Only specific values are allowed. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9cf05320f7ead132a60b89b6ec7559a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf05320f7ead132a60b89b6ec7559a4">◆ </a></span>setScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Group::setScene </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>scene</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall scene for the group. </p>
<p>Scenes are saved configurations for the lights in a group. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scene</td><td><a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a> name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0cbbc12721df742db97eb824a9356384"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cbbc12721df742db97eb824a9356384">◆ </a></span>transaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_state_transaction.html">StateTransaction</a> hueplusplus::Group::transaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a transaction for this group. </p>
<p>The transaction can be used to change more than one value in one request.</p>
<p>Example usage:</p><div class="fragment"><div class="line">group.<a class="code" href="classhueplusplus_1_1_group.html#a0cbbc12721df742db97eb824a9356384">transaction</a>().<a class="code" href="classhueplusplus_1_1_state_transaction.html#a3502aed5c5b47f058133358959c171e5">setBrightness</a>(240).<a class="code" href="classhueplusplus_1_1_state_transaction.html#a6861e2c1cdbf0e95b14b81869a5eb7de">setColorHue</a>(5000).<a class="code" href="classhueplusplus_1_1_state_transaction.html#aeb7dae7c01fdffad9e224e5393f83b85">commit</a>();</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a31395d0cf493a03eceebf87e634a93ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31395d0cf493a03eceebf87e634a93ea">◆ </a></span>id</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::Group::id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2043d08dd6a4d94efd6497e5d3ebe202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2043d08dd6a4d94efd6497e5d3ebe202">◆ </a></span>state</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_a_p_i_cache.html">APICache</a> hueplusplus::Group::state</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</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>