<!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/log.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="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">log.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 <boost/current_function.hpp></code><br />
<code>#include <ostream></code><br />
<code>#include <string></code><br />
</div>
<p><a href="log_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_1__log_1_1log.html">uhd::_log::log</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal logging object (called by UHD_LOG macros) <a href="classuhd_1_1__log_1_1log.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_1__log"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1__log.html">uhd::_log</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:a8991fb84b1de5fb137e40a8074a3d0a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8hpp.html#a8991fb84b1de5fb137e40a8074a3d0a0">UHD_LOGV</a>(verbosity)   <a class="el" href="classuhd_1_1__log_1_1log.html">uhd::_log::log</a>(uhd::_log::verbosity, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION)()</td></tr>
<tr class="separator:a8991fb84b1de5fb137e40a8074a3d0a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59b713f074ecaff20738b3b4aad2c21b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8hpp.html#a59b713f074ecaff20738b3b4aad2c21b">UHD_LOG</a>   <a class="el" href="log_8hpp.html#a8991fb84b1de5fb137e40a8074a3d0a0">UHD_LOGV</a>(regularly)</td></tr>
<tr class="separator:a59b713f074ecaff20738b3b4aad2c21b"><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:a8f054e8b8a286e1f5393c2b89dbbe152"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152">uhd::_log::verbosity_t</a> { <br />
  <a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152a1d75866c938e0f6af59e84b4592f5632">uhd::_log::always</a> = 1,
<a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152ab1f6c4fa1130442b882d7924191f5955">uhd::_log::often</a> = 2,
<a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152add9505c0a595fe73f0dd7e2d9045bd28">uhd::_log::regularly</a> = 3,
<a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152a694de2de72a61547a379640daa680073">uhd::_log::rarely</a> = 4,
<br />
  <a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152a00827db86a757c988bd01f9ccba19b53">uhd::_log::very_rarely</a> = 5,
<a class="el" href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152a88f48c8cc4858df4cb2719f47b1d11a7">uhd::_log::never</a> = 6
<br />
}</td></tr>
<tr class="memdesc:a8f054e8b8a286e1f5393c2b89dbbe152"><td class="mdescLeft"> </td><td class="mdescRight">Verbosity levels for the logger. <a href="namespaceuhd_1_1__log.html#a8f054e8b8a286e1f5393c2b89dbbe152">More...</a><br /></td></tr>
<tr class="separator:a8f054e8b8a286e1f5393c2b89dbbe152"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The UHD logging facility.</p>
<p>The logger enables UHD library code to easily log events into a file. Log entries are time-stamped and stored with file, line, and function. Each call to the UHD_LOG macros is synchronous and thread-safe.</p>
<p>The log file can be found in the path <temp-directory>/uhd.log, where <temp-directory> is the user or system's temporary directory. To override <temp-directory>, set the UHD_TEMP_PATH environment variable.</p>
<p>All log messages with verbosity greater than or equal to the log level (in other words, as often or less often than the current log level) are recorded into the log file. All other messages are sent to null.</p>
<p>The default log level is "never", but can be overridden:</p><ul>
<li>at compile time by setting the pre-processor define UHD_LOG_LEVEL.</li>
<li>at runtime by setting the environment variable UHD_LOG_LEVEL.</li>
</ul>
<p>UHD_LOG_LEVEL can be the name of a verbosity enum or integer value:</p><ul>
<li>Example pre-processor define: -DUHD_LOG_LEVEL=3</li>
<li>Example pre-processor define: -DUHD_LOG_LEVEL=regularly</li>
<li>Example environment variable: export UHD_LOG_LEVEL=3</li>
<li>Example environment variable: export UHD_LOG_LEVEL=regularly </li>
</ul>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a59b713f074ecaff20738b3b4aad2c21b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHD_LOG   <a class="el" href="log_8hpp.html#a8991fb84b1de5fb137e40a8074a3d0a0">UHD_LOGV</a>(regularly)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A UHD logger macro with default verbosity. Usage: UHD_LOG << "the log message" << std::endl; </p>
</div>
</div>
<a class="anchor" id="a8991fb84b1de5fb137e40a8074a3d0a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHD_LOGV</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">verbosity</td><td>)</td>
<td>   <a class="el" href="classuhd_1_1__log_1_1log.html">uhd::_log::log</a>(uhd::_log::verbosity, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION)()</td>
</tr>
</table>
</div><div class="memdoc">
<p>A UHD logger macro with configurable verbosity. Usage: <a class="el" href="log_8hpp.html#a8991fb84b1de5fb137e40a8074a3d0a0">UHD_LOGV(very_rarely)</a> << "the log message" << std::endl; </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>
