classhueplusplus_1_1_resource_list.html
52.8 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
<!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::ResourceList< Resource, IdT > Class Template 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_resource_list.html">ResourceList</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classhueplusplus_1_1_resource_list-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::ResourceList< Resource, IdT > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Handles a list of a certain API resource.
<a href="classhueplusplus_1_1_resource_list.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_resource_list_8h_source.html">hueplusplus/ResourceList.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a177194d18e9f0f37228a262d6dd6a73c"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a177194d18e9f0f37228a262d6dd6a73c">ResourceType</a> = Resource</td></tr>
<tr class="separator:a177194d18e9f0f37228a262d6dd6a73c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab122d90e1fcfde172b21670c74b33f89"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> = IdT</td></tr>
<tr class="separator:ab122d90e1fcfde172b21670c74b33f89"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a92d644c4440523ba31d36da291ce499a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a92d644c4440523ba31d36da291ce499a">ResourceList</a> (std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > baseCache, const std::string &cacheEntry, std::chrono::steady_clock::duration refreshDuration, bool <a class="el" href="classhueplusplus_1_1_resource_list.html#abc08e43ff0bd00145331db6a39fd1708">sharedState</a>=false, const std::function< Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json &, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &)> &<a class="el" href="classhueplusplus_1_1_resource_list.html#ac5777102379d55049380d777e779f56f">factory</a>=nullptr)</td></tr>
<tr class="memdesc:a92d644c4440523ba31d36da291ce499a"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classhueplusplus_1_1_resource_list.html" title="Handles a list of a certain API resource. ">ResourceList</a> using a base cache and optional factory function. <a href="#a92d644c4440523ba31d36da291ce499a">More...</a><br /></td></tr>
<tr class="separator:a92d644c4440523ba31d36da291ce499a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ad0fc473c4b3ac35210da9f2909e034"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a3ad0fc473c4b3ac35210da9f2909e034">ResourceList</a> (const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> &commands, const std::string &<a class="el" href="classhueplusplus_1_1_resource_list.html#ac3490f9e6b165f3a71c13337887a1a88">path</a>, std::chrono::steady_clock::duration refreshDuration, const std::function< Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json &, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &)> &<a class="el" href="classhueplusplus_1_1_resource_list.html#ac5777102379d55049380d777e779f56f">factory</a>=nullptr)</td></tr>
<tr class="memdesc:a3ad0fc473c4b3ac35210da9f2909e034"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classhueplusplus_1_1_resource_list.html" title="Handles a list of a certain API resource. ">ResourceList</a> with a separate cache and optional factory function. <a href="#a3ad0fc473c4b3ac35210da9f2909e034">More...</a><br /></td></tr>
<tr class="separator:a3ad0fc473c4b3ac35210da9f2909e034"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a165b892a0100a4ec6b575a2076f6bb8d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a165b892a0100a4ec6b575a2076f6bb8d">ResourceList</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> &)=delete</td></tr>
<tr class="memdesc:a165b892a0100a4ec6b575a2076f6bb8d"><td class="mdescLeft"> </td><td class="mdescRight">Deleted copy constructor. <a href="#a165b892a0100a4ec6b575a2076f6bb8d">More...</a><br /></td></tr>
<tr class="separator:a165b892a0100a4ec6b575a2076f6bb8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa75121b18d67faf84ff6b894d0c45b0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#aa75121b18d67faf84ff6b894d0c45b0b">operator=</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> &)=delete</td></tr>
<tr class="memdesc:aa75121b18d67faf84ff6b894d0c45b0b"><td class="mdescLeft"> </td><td class="mdescRight">Deleted copy assignment. <a href="#aa75121b18d67faf84ff6b894d0c45b0b">More...</a><br /></td></tr>
<tr class="separator:aa75121b18d67faf84ff6b894d0c45b0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fe81cf76931d2bcf9dda56ea63524bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a6fe81cf76931d2bcf9dda56ea63524bd">refresh</a> ()</td></tr>
<tr class="memdesc:a6fe81cf76931d2bcf9dda56ea63524bd"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes internal state now. <a href="#a6fe81cf76931d2bcf9dda56ea63524bd">More...</a><br /></td></tr>
<tr class="separator:a6fe81cf76931d2bcf9dda56ea63524bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa165e446439defcae7d1bf05b4576739"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#aa165e446439defcae7d1bf05b4576739">setRefreshDuration</a> (std::chrono::steady_clock::duration refreshDuration)</td></tr>
<tr class="memdesc:aa165e446439defcae7d1bf05b4576739"><td class="mdescLeft"> </td><td class="mdescRight">Sets custom refresh interval for this list and all resources created. <a href="#aa165e446439defcae7d1bf05b4576739">More...</a><br /></td></tr>
<tr class="separator:aa165e446439defcae7d1bf05b4576739"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7b3bef47b0c09764377cbad327545df"><td class="memItemLeft" align="right" valign="top">std::vector< Resource > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ad7b3bef47b0c09764377cbad327545df">getAll</a> ()</td></tr>
<tr class="memdesc:ad7b3bef47b0c09764377cbad327545df"><td class="mdescLeft"> </td><td class="mdescRight">Get all resources that exist. <a href="#ad7b3bef47b0c09764377cbad327545df">More...</a><br /></td></tr>
<tr class="separator:ad7b3bef47b0c09764377cbad327545df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bcf2ed48e70e9f11a4b6bdc24e0e611"><td class="memItemLeft" align="right" valign="top">Resource </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a7bcf2ed48e70e9f11a4b6bdc24e0e611">get</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id)</td></tr>
<tr class="memdesc:a7bcf2ed48e70e9f11a4b6bdc24e0e611"><td class="mdescLeft"> </td><td class="mdescRight">Get resource specified by id. <a href="#a7bcf2ed48e70e9f11a4b6bdc24e0e611">More...</a><br /></td></tr>
<tr class="separator:a7bcf2ed48e70e9f11a4b6bdc24e0e611"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5e884eefde0a45d53f029a9f30a6ab7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#af5e884eefde0a45d53f029a9f30a6ab7">exists</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id)</td></tr>
<tr class="memdesc:af5e884eefde0a45d53f029a9f30a6ab7"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether resource with id exists. <a href="#af5e884eefde0a45d53f029a9f30a6ab7">More...</a><br /></td></tr>
<tr class="separator:af5e884eefde0a45d53f029a9f30a6ab7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c0219d853d551394020b7b482518070"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a8c0219d853d551394020b7b482518070">exists</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id) const</td></tr>
<tr class="memdesc:a8c0219d853d551394020b7b482518070"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether resource with id exists. <a href="#a8c0219d853d551394020b7b482518070">More...</a><br /></td></tr>
<tr class="separator:a8c0219d853d551394020b7b482518070"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac65ac738c8cf0eaac35634ccffa455f5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ac65ac738c8cf0eaac35634ccffa455f5">remove</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id)</td></tr>
<tr class="memdesc:ac65ac738c8cf0eaac35634ccffa455f5"><td class="mdescLeft"> </td><td class="mdescRight">Removes the resource. <a href="#ac65ac738c8cf0eaac35634ccffa455f5">More...</a><br /></td></tr>
<tr class="separator:ac65ac738c8cf0eaac35634ccffa455f5"><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:ab98434ae91b0868dcf9cb95dfa168c95"><td class="memItemLeft" align="right" valign="top">Resource </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ab98434ae91b0868dcf9cb95dfa168c95">construct</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id, const nlohmann::json &state)</td></tr>
<tr class="memdesc:ab98434ae91b0868dcf9cb95dfa168c95"><td class="mdescLeft"> </td><td class="mdescRight">Constructs resource using factory or constructor, if available. <a href="#ab98434ae91b0868dcf9cb95dfa168c95">More...</a><br /></td></tr>
<tr class="separator:ab98434ae91b0868dcf9cb95dfa168c95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a035501423175d4dc5d91b677de1a9c95"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#a035501423175d4dc5d91b677de1a9c95">ResourceList</a> (<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> &&)=default</td></tr>
<tr class="memdesc:a035501423175d4dc5d91b677de1a9c95"><td class="mdescLeft"> </td><td class="mdescRight">Protected defaulted move constructor. <a href="#a035501423175d4dc5d91b677de1a9c95">More...</a><br /></td></tr>
<tr class="separator:a035501423175d4dc5d91b677de1a9c95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd327e8fb74cc60ac100bc750af338a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#abd327e8fb74cc60ac100bc750af338a3">operator=</a> (<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> &&)=default</td></tr>
<tr class="memdesc:abd327e8fb74cc60ac100bc750af338a3"><td class="mdescLeft"> </td><td class="mdescRight">Protected defaulted move assignment. <a href="#abd327e8fb74cc60ac100bc750af338a3">More...</a><br /></td></tr>
<tr class="separator:abd327e8fb74cc60ac100bc750af338a3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:ab98e351ff57e1674cc5aa25f150a4471"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ab98e351ff57e1674cc5aa25f150a4471">maybeStoi</a> (const std::string &key)</td></tr>
<tr class="memdesc:ab98e351ff57e1674cc5aa25f150a4471"><td class="mdescLeft"> </td><td class="mdescRight">Calls std::stoi if IdType is int. <a href="#ab98e351ff57e1674cc5aa25f150a4471">More...</a><br /></td></tr>
<tr class="separator:ab98e351ff57e1674cc5aa25f150a4471"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae26bacb486e03c961d992da82d63fdd6"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ae26bacb486e03c961d992da82d63fdd6">maybeToString</a> (const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> &id)</td></tr>
<tr class="memdesc:ae26bacb486e03c961d992da82d63fdd6"><td class="mdescLeft"> </td><td class="mdescRight">Calls std::to_string if IdType is int. <a href="#ae26bacb486e03c961d992da82d63fdd6">More...</a><br /></td></tr>
<tr class="separator:ae26bacb486e03c961d992da82d63fdd6"><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:abc77b3be3e5e8da4c7b6cfe86637f048"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <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_resource_list.html#abc77b3be3e5e8da4c7b6cfe86637f048">stateCache</a></td></tr>
<tr class="separator:abc77b3be3e5e8da4c7b6cfe86637f048"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5777102379d55049380d777e779f56f"><td class="memItemLeft" align="right" valign="top">std::function< Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json &, const std::shared_ptr< <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_resource_list.html#ac5777102379d55049380d777e779f56f">factory</a></td></tr>
<tr class="separator:ac5777102379d55049380d777e779f56f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3490f9e6b165f3a71c13337887a1a88"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#ac3490f9e6b165f3a71c13337887a1a88">path</a></td></tr>
<tr class="separator:ac3490f9e6b165f3a71c13337887a1a88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc08e43ff0bd00145331db6a39fd1708"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_resource_list.html#abc08e43ff0bd00145331db6a39fd1708">sharedState</a></td></tr>
<tr class="separator:abc08e43ff0bd00145331db6a39fd1708"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename Resource, typename IdT><br />
class hueplusplus::ResourceList< Resource, IdT ></h3>
<p>Handles a list of a certain API resource. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Resource</td><td>Resource type that is in the list </td></tr>
<tr><td class="paramname">IdT</td><td>Type of the resource id. int or std::string</td></tr>
</table>
</dd>
</dl>
<p>The resources are assumed to be in an object with ids as keys. The Resource class needs a constructor that accepts <code>id</code>, <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a>, <code>refreshDuration</code> and <code>state</code>; otherwise a factory function needs to be provided that takes <code>id</code>, <code>state</code> and a base cache that is null when shared state is disabled. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab122d90e1fcfde172b21670c74b33f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab122d90e1fcfde172b21670c74b33f89">◆ </a></span>IdType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> = IdT</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a177194d18e9f0f37228a262d6dd6a73c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a177194d18e9f0f37228a262d6dd6a73c">◆ </a></span>ResourceType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html#a177194d18e9f0f37228a262d6dd6a73c">ResourceType</a> = Resource</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a92d644c4440523ba31d36da291ce499a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92d644c4440523ba31d36da291ce499a">◆ </a></span>ResourceList() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> </td>
<td>(</td>
<td class="paramtype">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 class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>cacheEntry</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">bool </td>
<td class="paramname"><em>sharedState</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::function< Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json &, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &)> & </td>
<td class="paramname"><em>factory</em> = <code>nullptr</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct <a class="el" href="classhueplusplus_1_1_resource_list.html" title="Handles a list of a certain API resource. ">ResourceList</a> using a base cache and optional factory function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">baseCache</td><td>Base cache which holds the parent state, not nullptr </td></tr>
<tr><td class="paramname">cacheEntry</td><td>Entry name of the list state in the base cache </td></tr>
<tr><td class="paramname">refreshDuration</td><td>Interval between refreshing the cache </td></tr>
<tr><td class="paramname">sharedState</td><td>Whether created resources should share the same base cache. </td></tr>
<tr><td class="paramname">factory</td><td>Optional factory function to create Resources. Necessary if Resource is not constructible as described above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3ad0fc473c4b3ac35210da9f2909e034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ad0fc473c4b3ac35210da9f2909e034">◆ </a></span>ResourceList() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> </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">const std::string & </td>
<td class="paramname"><em>path</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 std::function< Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json &, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &)> & </td>
<td class="paramname"><em>factory</em> = <code>nullptr</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct <a class="el" href="classhueplusplus_1_1_resource_list.html" title="Handles a list of a certain API resource. ">ResourceList</a> with a separate cache and optional factory function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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">path</td><td>Path of the resource list </td></tr>
<tr><td class="paramname">refreshDuration</td><td>Interval between refreshing the cache </td></tr>
<tr><td class="paramname">factory</td><td>Optional factory function to create Resources. Necessary if Resource is not constructible as described above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a165b892a0100a4ec6b575a2076f6bb8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a165b892a0100a4ec6b575a2076f6bb8d">◆ </a></span>ResourceList() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< Resource, IdT > & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy constructor. </p>
</div>
</div>
<a id="a035501423175d4dc5d91b677de1a9c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035501423175d4dc5d91b677de1a9c95">◆ </a></span>ResourceList() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< Resource, IdT > && </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected defaulted move constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab98434ae91b0868dcf9cb95dfa168c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab98434ae91b0868dcf9cb95dfa168c95">◆ </a></span>construct()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Resource <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::construct </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>state</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">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs resource using factory or constructor, if available. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<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 factory is nullptr and Resource cannot be constructed as specified above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af5e884eefde0a45d53f029a9f30a6ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5e884eefde0a45d53f029a9f30a6ab7">◆ </a></span>exists() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether resource with id exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Identifier of the resource to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true when the resource with given id exists </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 contains 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="a8c0219d853d551394020b7b482518070"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c0219d853d551394020b7b482518070">◆ </a></span>exists() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether resource with id exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Identifier of the resource to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true when the resource with given id exists </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This will not update the cache </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<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 the cache is empty </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7bcf2ed48e70e9f11a4b6bdc24e0e611"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bcf2ed48e70e9f11a4b6bdc24e0e611">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Resource <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get resource specified by id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Identifier of the resource </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resource matching the id </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 id does not exist </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="ad7b3bef47b0c09764377cbad327545df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7b3bef47b0c09764377cbad327545df">◆ </a></span>getAll()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector<Resource> <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::getAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all resources that exist. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of references to every Resource </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 contains 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="ab98e351ff57e1674cc5aa25f150a4471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab98e351ff57e1674cc5aa25f150a4471">◆ </a></span>maybeStoi()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::maybeStoi </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls std::stoi if IdType is int. </p>
</div>
</div>
<a id="ae26bacb486e03c961d992da82d63fdd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae26bacb486e03c961d992da82d63fdd6">◆ </a></span>maybeToString()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::maybeToString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls std::to_string if IdType is int. </p>
</div>
</div>
<a id="aa75121b18d67faf84ff6b894d0c45b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa75121b18d67faf84ff6b894d0c45b0b">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>& <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< Resource, IdT > & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy assignment. </p>
</div>
</div>
<a id="abd327e8fb74cc60ac100bc750af338a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd327e8fb74cc60ac100bc750af338a3">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>& <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< Resource, IdT > && </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected defaulted move assignment. </p>
</div>
</div>
<a id="a6fe81cf76931d2bcf9dda56ea63524bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fe81cf76931d2bcf9dda56ea63524bd">◆ </a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes internal state now. </p>
</div>
</div>
<a id="ac65ac738c8cf0eaac35634ccffa455f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac65ac738c8cf0eaac35634ccffa455f5">◆ </a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a> & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the resource. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Identifier of the resource to remove </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success </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 contains 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>
<p>If successful, invalidates references to the Resource removed. </p>
</div>
</div>
<a id="aa165e446439defcae7d1bf05b4576739"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa165e446439defcae7d1bf05b4576739">◆ </a></span>setRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets custom refresh interval for this list and all resources created. </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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac5777102379d55049380d777e779f56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5777102379d55049380d777e779f56f">◆ </a></span>factory</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::function<Resource(<a class="el" href="classhueplusplus_1_1_resource_list.html#ab122d90e1fcfde172b21670c74b33f89">IdType</a>, const nlohmann::json&, const std::shared_ptr<<a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a>>&)> <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::factory</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="ac3490f9e6b165f3a71c13337887a1a88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3490f9e6b165f3a71c13337887a1a88">◆ </a></span>path</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::path</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="abc08e43ff0bd00145331db6a39fd1708"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc08e43ff0bd00145331db6a39fd1708">◆ </a></span>sharedState</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::sharedState</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="abc77b3be3e5e8da4c7b6cfe86637f048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc77b3be3e5e8da4c7b6cfe86637f048">◆ </a></span>stateCache</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Resource, typename IdT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a>> <a class="el" href="classhueplusplus_1_1_resource_list.html">hueplusplus::ResourceList</a>< Resource, IdT >::stateCache</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 file:<ul>
<li>include/hueplusplus/<a class="el" href="_resource_list_8h_source.html">ResourceList.h</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>