<!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/utils/msg.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><li class="navelem"><a class="el" href="dir_f4b37310477eb290db01b88b258ae379.html">utils</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> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">msg.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 <<a class="el" href="pimpl_8hpp_source.html">uhd/utils/pimpl.hpp</a>></code><br /> <code>#include <ostream></code><br /> <code>#include <iomanip></code><br /> <code>#include <string></code><br /> </div> <p><a href="msg_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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1msg_1_1__msg.html">uhd::msg::_msg</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal message object (called by UHD_MSG macro) <a href="classuhd_1_1msg_1_1__msg.html#details">More...</a><br /></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> <tr class="memitem:namespaceuhd_1_1msg"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1msg.html">uhd::msg</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:ab71fc642612b85370d18b6e35f5fed15"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(type)   <a class="el" href="classuhd_1_1msg_1_1__msg.html">uhd::msg::_msg</a>(uhd::msg::type)()</td></tr> <tr class="separator:ab71fc642612b85370d18b6e35f5fed15"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ec718025802d29e8ed78a66e9a1908a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#a0ec718025802d29e8ed78a66e9a1908a">UHD_HERE</a>()   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << __FILE__ << ":" << __LINE__ << std::endl</td></tr> <tr class="memdesc:a0ec718025802d29e8ed78a66e9a1908a"><td class="mdescLeft"> </td><td class="mdescRight">Helpful debug tool to print site info. <a href="#a0ec718025802d29e8ed78a66e9a1908a">More...</a><br /></td></tr> <tr class="separator:a0ec718025802d29e8ed78a66e9a1908a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8439acc29dcd403f77b8a021f5c64f07"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#a8439acc29dcd403f77b8a021f5c64f07">UHD_VAR</a>(var)   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << #var << " = " << var << std::endl;</td></tr> <tr class="memdesc:a8439acc29dcd403f77b8a021f5c64f07"><td class="mdescLeft"> </td><td class="mdescRight">Helpful debug tool to print a variable. <a href="#a8439acc29dcd403f77b8a021f5c64f07">More...</a><br /></td></tr> <tr class="separator:a8439acc29dcd403f77b8a021f5c64f07"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a98e566c4d02f4b4a6f7d4c7f5385b7de"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#a98e566c4d02f4b4a6f7d4c7f5385b7de">UHD_HEX</a>(var)   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << #var << " = 0x" << std::hex << std::setfill('0') << std::setw(8) << var << std::dec << std::endl;</td></tr> <tr class="memdesc:a98e566c4d02f4b4a6f7d4c7f5385b7de"><td class="mdescLeft"> </td><td class="mdescRight">Helpful debug tool to print a variable in hex. <a href="#a98e566c4d02f4b4a6f7d4c7f5385b7de">More...</a><br /></td></tr> <tr class="separator:a98e566c4d02f4b4a6f7d4c7f5385b7de"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a45b6cdcb700a41c8f7020cc63a8bd1e3"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1msg.html#a45b6cdcb700a41c8f7020cc63a8bd1e3">uhd::msg::handler_t</a> )(type_t, const std::string &)</td></tr> <tr class="memdesc:a45b6cdcb700a41c8f7020cc63a8bd1e3"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for a user-registered message handler. <a href="#a45b6cdcb700a41c8f7020cc63a8bd1e3">More...</a><br /></td></tr> <tr class="separator:a45b6cdcb700a41c8f7020cc63a8bd1e3"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:a39e78d22a268a4f0375423a1d588139b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">uhd::msg::type_t</a> { <a class="el" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba4a6791e1c064188a13d6a802e0fe073a">uhd::msg::status</a> = 's', <a class="el" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139baeece253580978ed29753e248e36ca44b">uhd::msg::warning</a> = 'w', <a class="el" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba51300d826692a9c1b6e846aed789e3a6">uhd::msg::error</a> = 'e', <a class="el" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba6747ccde4b852b6baf912a96e4c90f4c">uhd::msg::fastpath</a> = 'f' }</td></tr> <tr class="memdesc:a39e78d22a268a4f0375423a1d588139b"><td class="mdescLeft"> </td><td class="mdescRight">Possible message types. <a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">More...</a><br /></td></tr> <tr class="separator:a39e78d22a268a4f0375423a1d588139b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:aa5380a801e1ac6b8a35aa95543fc3e8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1msg.html#aa5380a801e1ac6b8a35aa95543fc3e8e">uhd::msg::register_handler</a> (const handler_t &handler)</td></tr> <tr class="separator:aa5380a801e1ac6b8a35aa95543fc3e8e"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a0ec718025802d29e8ed78a66e9a1908a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_HERE</td> <td>(</td> <td class="paramname"></td><td>)</td> <td>   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << __FILE__ << ":" << __LINE__ << std::endl</td> </tr> </table> </div><div class="memdoc"> <p>Helpful debug tool to print site info. </p> </div> </div> <a class="anchor" id="a98e566c4d02f4b4a6f7d4c7f5385b7de"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_HEX</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">var</td><td>)</td> <td>   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << #var << " = 0x" << std::hex << std::setfill('0') << std::setw(8) << var << std::dec << std::endl;</td> </tr> </table> </div><div class="memdoc"> <p>Helpful debug tool to print a variable in hex. </p> </div> </div> <a class="anchor" id="ab71fc642612b85370d18b6e35f5fed15"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_MSG</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">type</td><td>)</td> <td>   <a class="el" href="classuhd_1_1msg_1_1__msg.html">uhd::msg::_msg</a>(uhd::msg::type)()</td> </tr> </table> </div><div class="memdoc"> <p>A UHD message macro with configurable type. Usage: <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG(warning)</a> << "some warning message" << std::endl; </p> </div> </div> <a class="anchor" id="a8439acc29dcd403f77b8a021f5c64f07"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UHD_VAR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">var</td><td>)</td> <td>   <a class="el" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">UHD_MSG</a>(status) << #var << " = " << var << std::endl;</td> </tr> </table> </div><div class="memdoc"> <p>Helpful debug tool to print a variable. </p> </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>