Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > eb4b034508697cc17e7c9cfffe7f772b > files > 294

uhd-doc-3.7.2-3.mga5.noarch.rpm

<!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 Source File</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
   &#160;<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&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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="headertitle">
<div class="title">msg.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="msg_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2011-2013 Ettus Research LLC</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// (at your option) any later version.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">// GNU General Public License for more details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">// You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">// along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#ifndef INCLUDED_UHD_UTILS_MSG_HPP</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#define INCLUDED_UHD_UTILS_MSG_HPP</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="config_8hpp.html">uhd/config.hpp</a>&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="pimpl_8hpp.html">uhd/utils/pimpl.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;ostream&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;iomanip&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="msg_8hpp.html#ab71fc642612b85370d18b6e35f5fed15">   31</a></span>&#160;<span class="preprocessor">#define UHD_MSG(type) \</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">    uhd::msg::_msg(uhd::msg::type)()</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="msg_8hpp.html#a0ec718025802d29e8ed78a66e9a1908a">   35</a></span>&#160;<span class="preprocessor">#define UHD_HERE() \</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">    UHD_MSG(status) &lt;&lt; __FILE__ &lt;&lt; &quot;:&quot; &lt;&lt; __LINE__ &lt;&lt; std::endl</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="msg_8hpp.html#a8439acc29dcd403f77b8a021f5c64f07">   39</a></span>&#160;<span class="preprocessor">#define UHD_VAR(var) \</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">    UHD_MSG(status) &lt;&lt; #var &lt;&lt; &quot; = &quot; &lt;&lt; var &lt;&lt; std::endl;</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="msg_8hpp.html#a98e566c4d02f4b4a6f7d4c7f5385b7de">   43</a></span>&#160;<span class="preprocessor">#define UHD_HEX(var) \</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">    UHD_MSG(status) &lt;&lt; #var &lt;&lt; &quot; = 0x&quot; &lt;&lt; std::hex &lt;&lt; std::setfill(&#39;0&#39;) &lt;&lt; std::setw(8) &lt;&lt; var &lt;&lt; std::dec &lt;&lt; std::endl;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html">   46</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceuhd.html">uhd</a>{ <span class="keyword">namespace </span>msg{</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">   49</a></span>&#160;    <span class="keyword">enum</span> <a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">type_t</a>{</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba4a6791e1c064188a13d6a802e0fe073a">   50</a></span>&#160;        <a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba4a6791e1c064188a13d6a802e0fe073a">status</a>  = <span class="charliteral">&#39;s&#39;</span>,</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139baeece253580978ed29753e248e36ca44b">   51</a></span>&#160;        <a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139baeece253580978ed29753e248e36ca44b">warning</a> = <span class="charliteral">&#39;w&#39;</span>,</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba51300d826692a9c1b6e846aed789e3a6">   52</a></span>&#160;        <a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba51300d826692a9c1b6e846aed789e3a6">error</a>   = <span class="charliteral">&#39;e&#39;</span>,</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba6747ccde4b852b6baf912a96e4c90f4c">   53</a></span>&#160;        <a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba6747ccde4b852b6baf912a96e4c90f4c">fastpath</a>= <span class="charliteral">&#39;f&#39;</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    };</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="namespaceuhd_1_1msg.html#a45b6cdcb700a41c8f7020cc63a8bd1e3">   57</a></span>&#160;    <span class="keyword">typedef</span> void (*<a class="code" href="namespaceuhd_1_1msg.html#a45b6cdcb700a41c8f7020cc63a8bd1e3">handler_t</a>)(<a class="code" href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">type_t</a>, <span class="keyword">const</span> std::string &amp;);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <span class="keywordtype">void</span> <a class="code" href="namespaceuhd_1_1msg.html#aa5380a801e1ac6b8a35aa95543fc3e8e">register_handler</a>(<span class="keyword">const</span> <a class="code" href="namespaceuhd_1_1msg.html#a45b6cdcb700a41c8f7020cc63a8bd1e3">handler_t</a> &amp;handler);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classuhd_1_1msg_1_1__msg.html">   68</a></span>&#160;    <span class="keyword">class </span><a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <a class="code" href="classuhd_1_1msg_1_1__msg.html">_msg</a>{</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        <a class="code" href="classuhd_1_1msg_1_1__msg.html">_msg</a>(<span class="keyword">const</span> type_t type);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        ~<a class="code" href="classuhd_1_1msg_1_1__msg.html">_msg</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        std::ostream &amp;operator()(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">private</span>:</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        <a class="code" href="pimpl_8hpp.html#ab8fecbb8670e0b9dbb186fc024edb2b9">UHD_PIMPL_DECL</a>(impl) _impl;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    };</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}} <span class="comment">//namespace uhd::msg</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_UHD_UTILS_MSG_HPP */</span><span class="preprocessor"></span></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a39e78d22a268a4f0375423a1d588139baeece253580978ed29753e248e36ca44b"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139baeece253580978ed29753e248e36ca44b">uhd::msg::warning</a></div><div class="ttdef"><b>Definition:</b> msg.hpp:51</div></div>
<div class="ttc" id="pimpl_8hpp_html"><div class="ttname"><a href="pimpl_8hpp.html">pimpl.hpp</a></div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a45b6cdcb700a41c8f7020cc63a8bd1e3"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a45b6cdcb700a41c8f7020cc63a8bd1e3">uhd::msg::handler_t</a></div><div class="ttdeci">void(* handler_t)(type_t, const std::string &amp;)</div><div class="ttdoc">Typedef for a user-registered message handler. </div><div class="ttdef"><b>Definition:</b> msg.hpp:57</div></div>
<div class="ttc" id="config_8hpp_html"><div class="ttname"><a href="config_8hpp.html">config.hpp</a></div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_aa5380a801e1ac6b8a35aa95543fc3e8e"><div class="ttname"><a href="namespaceuhd_1_1msg.html#aa5380a801e1ac6b8a35aa95543fc3e8e">uhd::msg::register_handler</a></div><div class="ttdeci">UHD_API void register_handler(const handler_t &amp;handler)</div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a39e78d22a268a4f0375423a1d588139b"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139b">uhd::msg::type_t</a></div><div class="ttdeci">type_t</div><div class="ttdoc">Possible message types. </div><div class="ttdef"><b>Definition:</b> msg.hpp:49</div></div>
<div class="ttc" id="config_8hpp_html_adc68e1c030efb88af856decedf19aedf"><div class="ttname"><a href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a></div><div class="ttdeci">#define UHD_API</div><div class="ttdef"><b>Definition:</b> config.hpp:79</div></div>
<div class="ttc" id="namespaceuhd_html"><div class="ttname"><a href="namespaceuhd.html">uhd</a></div><div class="ttdef"><b>Definition:</b> convert.hpp:28</div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a39e78d22a268a4f0375423a1d588139ba51300d826692a9c1b6e846aed789e3a6"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba51300d826692a9c1b6e846aed789e3a6">uhd::msg::error</a></div><div class="ttdef"><b>Definition:</b> msg.hpp:52</div></div>
<div class="ttc" id="pimpl_8hpp_html_ab8fecbb8670e0b9dbb186fc024edb2b9"><div class="ttname"><a href="pimpl_8hpp.html#ab8fecbb8670e0b9dbb186fc024edb2b9">UHD_PIMPL_DECL</a></div><div class="ttdeci">#define UHD_PIMPL_DECL(_name)</div><div class="ttdef"><b>Definition:</b> pimpl.hpp:42</div></div>
<div class="ttc" id="classuhd_1_1msg_1_1__msg_html"><div class="ttname"><a href="classuhd_1_1msg_1_1__msg.html">uhd::msg::_msg</a></div><div class="ttdoc">Internal message object (called by UHD_MSG macro) </div><div class="ttdef"><b>Definition:</b> msg.hpp:68</div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a39e78d22a268a4f0375423a1d588139ba6747ccde4b852b6baf912a96e4c90f4c"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba6747ccde4b852b6baf912a96e4c90f4c">uhd::msg::fastpath</a></div><div class="ttdef"><b>Definition:</b> msg.hpp:53</div></div>
<div class="ttc" id="namespaceuhd_1_1msg_html_a39e78d22a268a4f0375423a1d588139ba4a6791e1c064188a13d6a802e0fe073a"><div class="ttname"><a href="namespaceuhd_1_1msg.html#a39e78d22a268a4f0375423a1d588139ba4a6791e1c064188a13d6a802e0fe073a">uhd::msg::status</a></div><div class="ttdef"><b>Definition:</b> msg.hpp:50</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>