<!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.8"/> <title>UHD: include/uhd/exception.hpp File 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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">UHD  <span id="projectnumber">003.007.002-0-unknown</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b536c30bc5a9db2084d75e9c271ba6f.html">uhd</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#namespaces">Namespaces</a> | <a href="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">exception.hpp File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include <<a class="el" href="config_8hpp_source.html">uhd/config.hpp</a>></code><br /> <code>#include <boost/current_function.hpp></code><br /> <code>#include <stdexcept></code><br /> <code>#include <string></code><br /> </div> <p><a href="exception_8hpp_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1exception.html">uhd::exception</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1assertion__error.html">uhd::assertion_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1lookup__error.html">uhd::lookup_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1index__error.html">uhd::index_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1key__error.html">uhd::key_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1type__error.html">uhd::type_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1value__error.html">uhd::value_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1runtime__error.html">uhd::runtime_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1not__implemented__error.html">uhd::not_implemented_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1environment__error.html">uhd::environment_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1io__error.html">uhd::io_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1os__error.html">uhd::os_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1system__error.html">uhd::system_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> Namespaces</h2></td></tr> <tr class="memitem:namespaceuhd"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd.html">uhd</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a82e48ab01b6aa0c5688b4f6c5efaaad1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="exception_8hpp.html#a82e48ab01b6aa0c5688b4f6c5efaaad1">UHD_THROW_SITE_INFO</a>(what)</td></tr> <tr class="separator:a82e48ab01b6aa0c5688b4f6c5efaaad1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a993a48d45153c3a0b2805f641b322b79"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="exception_8hpp.html#a993a48d45153c3a0b2805f641b322b79">UHD_THROW_INVALID_CODE_PATH</a>()   throw <a class="el" href="structuhd_1_1system__error.html">uhd::system_error</a>(<a class="el" href="exception_8hpp.html#a82e48ab01b6aa0c5688b4f6c5efaaad1">UHD_THROW_SITE_INFO</a>("invalid code path"))</td></tr> <tr class="separator:a993a48d45153c3a0b2805f641b322b79"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a06fae24c6cceceb456db1bb46e525bf1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="exception_8hpp.html#a06fae24c6cceceb456db1bb46e525bf1">UHD_ASSERT_THROW</a>(code)</td></tr> <tr class="separator:a06fae24c6cceceb456db1bb46e525bf1"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a06fae24c6cceceb456db1bb46e525bf1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_ASSERT_THROW</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">code</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">{<span class="keywordflow">if</span> (not (code)) \</div> <div class="line"> throw <a class="code" href="structuhd_1_1assertion__error.html">uhd::assertion_error</a>(<a class="code" href="exception_8hpp.html#a82e48ab01b6aa0c5688b4f6c5efaaad1">UHD_THROW_SITE_INFO</a>(#code)); \</div> <div class="line"> }</div> <div class="ttc" id="structuhd_1_1assertion__error_html"><div class="ttname"><a href="structuhd_1_1assertion__error.html">uhd::assertion_error</a></div><div class="ttdef"><b>Definition:</b> exception.hpp:52</div></div> <div class="ttc" id="exception_8hpp_html_a82e48ab01b6aa0c5688b4f6c5efaaad1"><div class="ttname"><a href="exception_8hpp.html#a82e48ab01b6aa0c5688b4f6c5efaaad1">UHD_THROW_SITE_INFO</a></div><div class="ttdeci">#define UHD_THROW_SITE_INFO(what)</div><div class="ttdef"><b>Definition:</b> exception.hpp:142</div></div> </div><!-- fragment --><p>Assert the result of the code evaluation. If the code evaluates to false, throw an assertion error. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">code</td><td>the code that resolved to a boolean </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a993a48d45153c3a0b2805f641b322b79"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_THROW_INVALID_CODE_PATH</td> <td>(</td> <td class="paramname"></td><td>)</td> <td>   throw <a class="el" href="structuhd_1_1system__error.html">uhd::system_error</a>(<a class="el" href="exception_8hpp.html#a82e48ab01b6aa0c5688b4f6c5efaaad1">UHD_THROW_SITE_INFO</a>("invalid code path"))</td> </tr> </table> </div><div class="memdoc"> <p>Throws an invalid code path exception with throw-site information. Use this macro in places that code execution is not supposed to go. </p> </div> </div> <a class="anchor" id="a82e48ab01b6aa0c5688b4f6c5efaaad1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_THROW_SITE_INFO</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">what</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">std::string( \</div> <div class="line"> std::string(what) + <span class="stringliteral">"\n"</span> + \</div> <div class="line"> <span class="stringliteral">" in "</span> + std::string(BOOST_CURRENT_FUNCTION) + <span class="stringliteral">"\n"</span> + \</div> <div class="line"> <span class="stringliteral">" at "</span> + std::string(__FILE__) + <span class="stringliteral">":"</span> + BOOST_STRINGIZE(__LINE__) + <span class="stringliteral">"\n"</span> \</div> <div class="line"> )</div> </div><!-- fragment --><p>Create a formated string with throw-site information. Fills in the function name, file name, and line number. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">what</td><td>the std::exeption message </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the formatted exception message </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>