classhueplusplus_1_1_hue_exception.html
14.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!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::HueException 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_hue_exception.html">HueException</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="classhueplusplus_1_1_hue_exception-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::HueException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Exception class with file information. Base class of all custom exception classes.
<a href="classhueplusplus_1_1_hue_exception.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_hue_exception_8h_source.html">hueplusplus/HueException.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="+"/> Inheritance diagram for hueplusplus::HueException:</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_hue_exception__inherit__graph.png" border="0" usemap="#hueplusplus_1_1_hue_exception_inherit__map" alt="Inheritance graph"/></div>
<map name="hueplusplus_1_1_hue_exception_inherit__map" id="hueplusplus_1_1_hue_exception_inherit__map">
<area shape="rect" id="node3" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. " alt="" coords="5,155,223,196"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for hueplusplus::HueException:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classhueplusplus_1_1_hue_exception__coll__graph.png" border="0" usemap="#hueplusplus_1_1_hue_exception_coll__map" alt="Collaboration graph"/></div>
<map name="hueplusplus_1_1_hue_exception_coll__map" id="hueplusplus_1_1_hue_exception_coll__map">
</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:ab5560b225c1f36625477c2bffb8a9f1a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_exception.html#ab5560b225c1f36625477c2bffb8a9f1a">HueException</a> (<a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo, const std::string &message)</td></tr>
<tr class="memdesc:ab5560b225c1f36625477c2bffb8a9f1a"><td class="mdescLeft"> </td><td class="mdescRight">Creates <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> with information about the error and source. <a href="#ab5560b225c1f36625477c2bffb8a9f1a">More...</a><br /></td></tr>
<tr class="separator:ab5560b225c1f36625477c2bffb8a9f1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae65aa461204544aaf3899d5eb974efa2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_exception.html#ae65aa461204544aaf3899d5eb974efa2">what</a> () const noexcept override</td></tr>
<tr class="memdesc:ae65aa461204544aaf3899d5eb974efa2"><td class="mdescLeft"> </td><td class="mdescRight">What message of the exception. <a href="#ae65aa461204544aaf3899d5eb974efa2">More...</a><br /></td></tr>
<tr class="separator:ae65aa461204544aaf3899d5eb974efa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c2cd1e98f9b86ca85fd493de62c5c91"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_exception.html#a1c2cd1e98f9b86ca85fd493de62c5c91">GetFile</a> () const noexcept</td></tr>
<tr class="memdesc:a1c2cd1e98f9b86ca85fd493de62c5c91"><td class="mdescLeft"> </td><td class="mdescRight">Filename and line where the exception was thrown or caused by. <a href="#a1c2cd1e98f9b86ca85fd493de62c5c91">More...</a><br /></td></tr>
<tr class="separator:a1c2cd1e98f9b86ca85fd493de62c5c91"><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:a73370d57f033b42c41b5ba55b5db0148"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_exception.html#a73370d57f033b42c41b5ba55b5db0148">HueException</a> (const char *exceptionName, <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo, const std::string &message)</td></tr>
<tr class="memdesc:a73370d57f033b42c41b5ba55b5db0148"><td class="mdescLeft"> </td><td class="mdescRight">Creates <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> with child class name. <a href="#a73370d57f033b42c41b5ba55b5db0148">More...</a><br /></td></tr>
<tr class="separator:a73370d57f033b42c41b5ba55b5db0148"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exception class with file information. Base class of all custom exception classes. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab5560b225c1f36625477c2bffb8a9f1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5560b225c1f36625477c2bffb8a9f1a">◆ </a></span>HueException() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::HueException::HueException </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 class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates <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> with information about the error and source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fileInfo</td><td>Source of the error. Must not always be the throw location, can also be a calling function which matches the cause better. </td></tr>
<tr><td class="paramname">message</td><td>Human readable error message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a73370d57f033b42c41b5ba55b5db0148"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73370d57f033b42c41b5ba55b5db0148">◆ </a></span>HueException() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::HueException::HueException </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>exceptionName</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 class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</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>Creates <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> with child class name. </p>
<p>Should be used by subclasses which can append additional information to the end of whatMessage. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">exceptionName</td><td>class name of the subclass </td></tr>
<tr><td class="paramname">fileInfo</td><td>Source of the error. Must not always be the throw location, can also be a calling function which matches the cause better. </td></tr>
<tr><td class="paramname">message</td><td>Human readable error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1c2cd1e98f9b86ca85fd493de62c5c91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c2cd1e98f9b86ca85fd493de62c5c91">◆ </a></span>GetFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> & hueplusplus::HueException::GetFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Filename and line where the exception was thrown or caused by. </p>
</div>
</div>
<a id="ae65aa461204544aaf3899d5eb974efa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae65aa461204544aaf3899d5eb974efa2">◆ </a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * hueplusplus::HueException::what </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>What message of the exception. </p>
<dl class="section return"><dt>Returns</dt><dd>exception name, file info and constructor message as char* into member string </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_hue_exception_8h_source.html">HueException.h</a></li>
<li>src/<a class="el" href="_hue_exception_8cpp.html">HueException.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>