classhueplusplus_1_1_hue_a_p_i_response_exception.html 20.9 KB

Edit Raw Blame History Permalink

<!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::HueAPIResponseException 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
   &#160;<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_a_p_i_response_exception.html">HueAPIResponseException</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classhueplusplus_1_1_hue_a_p_i_response_exception-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">hueplusplus::HueAPIResponseException Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Exception caused by a Hue API "error" response with additional information.
 <a href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_hue_exception_8h_source.html">hueplusplus/HueException.h</a>&gt;</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::HueAPIResponseException:</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_a_p_i_response_exception__inherit__graph.png" border="0" usemap="#hueplusplus_1_1_hue_a_p_i_response_exception_inherit__map" alt="Inheritance graph"/></div>
<map name="hueplusplus_1_1_hue_a_p_i_response_exception_inherit__map" id="hueplusplus_1_1_hue_a_p_i_response_exception_inherit__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. " alt="" coords="15,80,213,107"/>
</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::HueAPIResponseException:</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_a_p_i_response_exception__coll__graph.png" border="0" usemap="#hueplusplus_1_1_hue_a_p_i_response_exception_coll__map" alt="Collaboration graph"/></div>
<map name="hueplusplus_1_1_hue_a_p_i_response_exception_coll__map" id="hueplusplus_1_1_hue_a_p_i_response_exception_coll__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. " alt="" coords="15,80,213,107"/>
</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:a67c014cbd5145f10eecc9ac789e219a7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#a67c014cbd5145f10eecc9ac789e219a7">HueAPIResponseException</a> (<a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo, int error, std::string address, std::string description)</td></tr>
<tr class="memdesc:a67c014cbd5145f10eecc9ac789e219a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create exception with info from Hue API error.  <a href="#a67c014cbd5145f10eecc9ac789e219a7">More...</a><br /></td></tr>
<tr class="separator:a67c014cbd5145f10eecc9ac789e219a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2b4971e74b5c257674c0d3b8836bd94"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#ad2b4971e74b5c257674c0d3b8836bd94">GetErrorNumber</a> () const noexcept</td></tr>
<tr class="memdesc:ad2b4971e74b5c257674c0d3b8836bd94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error number from Hue API error response.  <a href="#ad2b4971e74b5c257674c0d3b8836bd94">More...</a><br /></td></tr>
<tr class="separator:ad2b4971e74b5c257674c0d3b8836bd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09d3e179c87c248ad93fc89b15e3a2f4"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#a09d3e179c87c248ad93fc89b15e3a2f4">GetAddress</a> () const noexcept</td></tr>
<tr class="memdesc:a09d3e179c87c248ad93fc89b15e3a2f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address the API call tried to access.  <a href="#a09d3e179c87c248ad93fc89b15e3a2f4">More...</a><br /></td></tr>
<tr class="separator:a09d3e179c87c248ad93fc89b15e3a2f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88e40694e6f6453b43ac669792bd8a3d"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#a88e40694e6f6453b43ac669792bd8a3d">GetDescription</a> () const noexcept</td></tr>
<tr class="memdesc:a88e40694e6f6453b43ac669792bd8a3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error description.  <a href="#a88e40694e6f6453b43ac669792bd8a3d">More...</a><br /></td></tr>
<tr class="separator:a88e40694e6f6453b43ac669792bd8a3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classhueplusplus_1_1_hue_exception"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhueplusplus_1_1_hue_exception')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classhueplusplus_1_1_hue_exception.html">hueplusplus::HueException</a></td></tr>
<tr class="memitem:ab5560b225c1f36625477c2bffb8a9f1a inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memItemLeft" align="right" valign="top">&#160;</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 &amp;message)</td></tr>
<tr class="memdesc:ab5560b225c1f36625477c2bffb8a9f1a inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="mdescLeft">&#160;</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="classhueplusplus_1_1_hue_exception.html#ab5560b225c1f36625477c2bffb8a9f1a">More...</a><br /></td></tr>
<tr class="separator:ab5560b225c1f36625477c2bffb8a9f1a inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65aa461204544aaf3899d5eb974efa2 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">What message of the exception.  <a href="classhueplusplus_1_1_hue_exception.html#ae65aa461204544aaf3899d5eb974efa2">More...</a><br /></td></tr>
<tr class="separator:ae65aa461204544aaf3899d5eb974efa2 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2cd1e98f9b86ca85fd493de62c5c91 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> &amp;&#160;</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 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filename and line where the exception was thrown or caused by.  <a href="classhueplusplus_1_1_hue_exception.html#a1c2cd1e98f9b86ca85fd493de62c5c91">More...</a><br /></td></tr>
<tr class="separator:a1c2cd1e98f9b86ca85fd493de62c5c91 inherit pub_methods_classhueplusplus_1_1_hue_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a8df7ec2ba910a8a3abc7a3f67d326697"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html">HueAPIResponseException</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html#a8df7ec2ba910a8a3abc7a3f67d326697">Create</a> (<a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo, const nlohmann::json &amp;response)</td></tr>
<tr class="memdesc:a8df7ec2ba910a8a3abc7a3f67d326697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates exception from API response.  <a href="#a8df7ec2ba910a8a3abc7a3f67d326697">More...</a><br /></td></tr>
<tr class="separator:a8df7ec2ba910a8a3abc7a3f67d326697"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classhueplusplus_1_1_hue_exception"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classhueplusplus_1_1_hue_exception')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classhueplusplus_1_1_hue_exception.html">hueplusplus::HueException</a></td></tr>
<tr class="memitem:a73370d57f033b42c41b5ba55b5db0148 inherit pro_methods_classhueplusplus_1_1_hue_exception"><td class="memItemLeft" align="right" valign="top">&#160;</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 &amp;message)</td></tr>
<tr class="memdesc:a73370d57f033b42c41b5ba55b5db0148 inherit pro_methods_classhueplusplus_1_1_hue_exception"><td class="mdescLeft">&#160;</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="classhueplusplus_1_1_hue_exception.html#a73370d57f033b42c41b5ba55b5db0148">More...</a><br /></td></tr>
<tr class="separator:a73370d57f033b42c41b5ba55b5db0148 inherit pro_methods_classhueplusplus_1_1_hue_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exception caused by a Hue API "error" response with additional information. </p>
<p>Refer to Hue developer documentation for more detail on specific error codes. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a67c014cbd5145f10eecc9ac789e219a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c014cbd5145f10eecc9ac789e219a7">&#9670;&nbsp;</a></span>HueAPIResponseException()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">hueplusplus::HueAPIResponseException::HueAPIResponseException </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a>&#160;</td>
          <td class="paramname"><em>fileInfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>error</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>description</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create exception with info from Hue API error. </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">error</td><td>Hue API error code from error response. </td></tr>
    <tr><td class="paramname">address</td><td>URI the API call referred to from error response. </td></tr>
    <tr><td class="paramname">description</td><td>Error description from response. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8df7ec2ba910a8a3abc7a3f67d326697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8df7ec2ba910a8a3abc7a3f67d326697">&#9670;&nbsp;</a></span>Create()</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_hue_a_p_i_response_exception.html">HueAPIResponseException</a> hueplusplus::HueAPIResponseException::Create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a>&#160;</td>
          <td class="paramname"><em>fileInfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const nlohmann::json &amp;&#160;</td>
          <td class="paramname"><em>response</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates exception from API response. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileInfo</td><td>Location of the cause </td></tr>
    <tr><td class="paramname">response</td><td>Hue API response. Must contain a member "error" with "type", "address" and "description". </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API &quot;error&quot; response with additional information. ">HueAPIResponseException</a> with info from the response. If response does not contain the required members, they are defaulted to -1 or "". </dd></dl>

</div>
</div>
<a id="a09d3e179c87c248ad93fc89b15e3a2f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09d3e179c87c248ad93fc89b15e3a2f4">&#9670;&nbsp;</a></span>GetAddress()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; hueplusplus::HueAPIResponseException::GetAddress </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>Address the API call tried to access. </p>

</div>
</div>
<a id="a88e40694e6f6453b43ac669792bd8a3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88e40694e6f6453b43ac669792bd8a3d">&#9670;&nbsp;</a></span>GetDescription()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; hueplusplus::HueAPIResponseException::GetDescription </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>Error description. </p>

</div>
</div>
<a id="ad2b4971e74b5c257674c0d3b8836bd94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2b4971e74b5c257674c0d3b8836bd94">&#9670;&nbsp;</a></span>GetErrorNumber()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int hueplusplus::HueAPIResponseException::GetErrorNumber </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>Error number from Hue API error response. </p>
<p>Refer to Hue developer documentation for meaning of error codes. </p>

</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>