<!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"/>
<title>GNU Radio 3.2.2 C++ API: common.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('common_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>common.h</h1> </div>
</div>
<div class="contents">
<a href="common_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2006,2007,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef INCLUDED_MB_COMMON_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_MB_COMMON_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <pmt.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <vector></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdexcept></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <boost/utility.hpp></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/enable_shared_from_this.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <boost/weak_ptr.hpp></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">/*</span>
<a name="l00032"></a>00032 <span class="comment"> * The priority type and valid range</span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a><a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">00034</a> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a>;
<a name="l00035"></a><a class="code" href="common_8h.html#aca022884cadbaf5f5eb2831a76399a52">00035</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="common_8h.html#aca022884cadbaf5f5eb2831a76399a52">MB_PRI_BEST</a> = 0;
<a name="l00036"></a><a class="code" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">00036</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">MB_PRI_DEFAULT</a> = 4;
<a name="l00037"></a><a class="code" href="common_8h.html#aba02449fafffecb0bc93a1680db0623b">00037</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="common_8h.html#aba02449fafffecb0bc93a1680db0623b">MB_PRI_WORST</a> = 7;
<a name="l00038"></a><a class="code" href="common_8h.html#a6006b64fbafeef25e9c44c503b88db05">00038</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="common_8h.html#a6006b64fbafeef25e9c44c503b88db05">MB_NPRI</a> = <a class="code" href="common_8h.html#aba02449fafffecb0bc93a1680db0623b">MB_PRI_WORST</a> + 1; <span class="comment">// number of valid priorities </span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment">/*!</span>
<a name="l00041"></a>00041 <span class="comment"> * \brief return true iff priority a is better than priority b</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00044"></a><a class="code" href="common_8h.html#af46d2f000006914a26963c1af9abf44b">00044</a> <a class="code" href="common_8h.html#af46d2f000006914a26963c1af9abf44b" title="return true iff priority a is better than priority b">mb_pri_better</a>(<a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> a, <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> b)
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keywordflow">return</span> a < b;
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/*!</span>
<a name="l00050"></a>00050 <span class="comment"> * \brief return true iff priority a is worse than priority b</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00053"></a><a class="code" href="common_8h.html#a1a85f754c06f27b350babcb41c0e96df">00053</a> <a class="code" href="common_8h.html#a1a85f754c06f27b350babcb41c0e96df" title="return true iff priority a is worse than priority b">mb_pri_worse</a>(<a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> a, <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> b)
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keywordflow">return</span> a > b;
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/*!</span>
<a name="l00059"></a>00059 <span class="comment"> * \brief ensure that pri is valid</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061 <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a>
<a name="l00062"></a><a class="code" href="common_8h.html#a4bf98bc0240495bf6d5720f540ab1e77">00062</a> <a class="code" href="common_8h.html#a4bf98bc0240495bf6d5720f540ab1e77" title="ensure that pri is valid">mb_pri_clamp</a>(<a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> p)
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 <span class="keywordflow">return</span> p < <a class="code" href="common_8h.html#a6006b64fbafeef25e9c44c503b88db05">MB_NPRI</a> ? p : <a class="code" href="common_8h.html#a6006b64fbafeef25e9c44c503b88db05">MB_NPRI</a> - 1;
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">class </span><a class="code" href="classmb__runtime.html" title="Abstract runtime support for m-blocks.">mb_runtime</a>;
<a name="l00068"></a>00068 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<mb_runtime></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">mb_runtime_sptr</a>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">//class mb_runtime_impl;</span>
<a name="l00071"></a>00071 <span class="comment">//typedef boost::shared_ptr<mb_runtime_impl> mb_runtime_impl_sptr;</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">class </span><a class="code" href="classmb__mblock.html" title="Parent class for all message passing blocks.">mb_mblock</a>;
<a name="l00074"></a>00074 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<mb_mblock></a> <a class="code" href="classboost_1_1shared__ptr.html">mb_mblock_sptr</a>;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">class </span><a class="code" href="classmb__mblock__impl.html" title="The private implementation details of the mblock system.">mb_mblock_impl</a>;
<a name="l00077"></a>00077 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<mb_mblock_impl></a> <a class="code" href="classboost_1_1shared__ptr.html">mb_mblock_impl_sptr</a>;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keyword">class </span><a class="code" href="classmb__port.html" title="Abstract port characteristics.">mb_port</a>;
<a name="l00080"></a>00080 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<mb_port></a> <a class="code" href="classboost_1_1shared__ptr.html">mb_port_sptr</a>;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">//class mb_port_detail;</span>
<a name="l00083"></a>00083 <span class="comment">//typedef boost::shared_ptr<mb_port_detail> mb_port_detail_sptr;</span>
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">class </span><a class="code" href="classmb__msg__accepter.html" title="Abstract class that accepts messages.">mb_msg_accepter</a>;
<a name="l00086"></a>00086 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<mb_msg_accepter></a> <a class="code" href="classboost_1_1shared__ptr.html">mb_msg_accepter_sptr</a>;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">class </span><a class="code" href="classmb__message.html">mb_message</a>;
<a name="l00089"></a>00089 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<mb_message></a> <a class="code" href="classboost_1_1shared__ptr.html">mb_message_sptr</a>;
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">class </span><a class="code" href="classmb__msg__queue.html" title="priority queue for mblock messages">mb_msg_queue</a>;
<a name="l00092"></a>00092 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<mb_msg_queue></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">mb_msg_queue_sptr</a>;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_MB_COMMON_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="common_8h.html">common.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
3080
