<!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: message.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('message_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>message.h</h1> </div>
</div>
<div class="contents">
<a href="message_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_MESSAGE_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_MB_MESSAGE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <mblock/common.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <iosfwd></span>
<a name="l00026"></a>00026
<a name="l00027"></a><a class="code" href="message_8h.html#ad44fd306d187d8817ef9f2abc8c73b7f">00027</a> <span class="preprocessor">#define MB_MESSAGE_LOCAL_ALLOCATOR 0 // define to 0 or 1</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classmb__message.html">mb_message</a>;
<a name="l00030"></a>00030 <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="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/*!</span>
<a name="l00033"></a>00033 <span class="comment"> * \brief construct a message and return boost::shared_ptr</span>
<a name="l00034"></a>00034 <span class="comment"> *</span>
<a name="l00035"></a>00035 <span class="comment"> * \param signal identifier of the message</span>
<a name="l00036"></a>00036 <span class="comment"> * \param data the data to be operated on</span>
<a name="l00037"></a>00037 <span class="comment"> * \param metadata information about the data</span>
<a name="l00038"></a>00038 <span class="comment"> * \param priority urgency</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a>00040 <a class="code" href="classboost_1_1shared__ptr.html">mb_message_sptr</a>
<a name="l00041"></a>00041 <a class="code" href="message_8h.html#a04d3d9244e2f581e0ec7756ca1b78135" title="construct a message and return boost::shared_ptr">mb_make_message</a>(<a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">signal</a>,
<a name="l00042"></a>00042 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">data</a> = PMT_NIL,
<a name="l00043"></a>00043 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">metadata</a> = PMT_NIL,
<a name="l00044"></a>00044 <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">priority</a> = <a class="code" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">MB_PRI_DEFAULT</a>);
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classmb__message.html">00046</a> <span class="keyword">class </span><a class="code" href="classmb__message.html">mb_message</a> {
<a name="l00047"></a>00047 <a class="code" href="classboost_1_1shared__ptr.html">mb_message_sptr</a> d_next; <span class="comment">// link field for msg queue</span>
<a name="l00048"></a>00048 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> d_signal;
<a name="l00049"></a>00049 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> d_data;
<a name="l00050"></a>00050 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> d_metadata;
<a name="l00051"></a>00051 <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> d_priority;
<a name="l00052"></a>00052 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> d_port_id; <span class="comment">// name of port msg was rcvd on (symbol)</span>
<a name="l00053"></a>00053
<a name="l00054"></a><a class="code" href="classmb__message.html#a682d496c07a35ef2e0f7e652ce238c5f">00054</a> <span class="keyword">friend</span> <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="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html">mb_message_sptr</a>
<a name="l00057"></a>00057 <a class="code" href="classmb__message.html#ae4a799d3192b1f59eda195787d3725f7" title="construct a message and return boost::shared_ptr">mb_make_message</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">signal</a>, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">data</a>, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">metadata</a>, <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">priority</a>);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">// private constructor</span>
<a name="l00060"></a>00060 <a class="code" href="classmb__message.html">mb_message</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">signal</a>, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">data</a>, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">metadata</a>, <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">priority</a>);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063 <a class="code" href="classmb__message.html#a7be7eb5f450f58c224cb57a53b96d07d">~mb_message</a>();
<a name="l00064"></a>00064
<a name="l00065"></a><a class="code" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">00065</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">signal</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_signal; }
<a name="l00066"></a><a class="code" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">00066</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">data</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_data; }
<a name="l00067"></a><a class="code" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">00067</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">metadata</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_metadata; }
<a name="l00068"></a><a class="code" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">00068</a> <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> <a class="code" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">priority</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_priority; }
<a name="l00069"></a><a class="code" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">00069</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">port_id</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_port_id; }
<a name="l00070"></a>00070
<a name="l00071"></a><a class="code" href="classmb__message.html#a6f0f3d212ff6a8945ca4229489681ea3">00071</a> <span class="keywordtype">void</span> <a class="code" href="classmb__message.html#a6f0f3d212ff6a8945ca4229489681ea3">set_port_id</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">pmt_t</a> <a class="code" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">port_id</a>){ d_port_id = <a class="code" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">port_id</a>; }
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="preprocessor">#if (MB_MESSAGE_LOCAL_ALLOCATOR)</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span> <span class="keywordtype">void</span> *operator new(<span class="keywordtype">size_t</span>);
<a name="l00075"></a>00075 <span class="keywordtype">void</span> operator delete(<span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>);
<a name="l00076"></a>00076 <span class="preprocessor">#endif</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span>};
<a name="l00078"></a>00078
<a name="l00079"></a>00079 std::ostream& <a class="code" href="gr__basic__block_8h.html#acb2f610728a7f3cbd51a9a2eb60f059e">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classmb__message.html">mb_message</a> &msg);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">inline</span>
<a name="l00082"></a><a class="code" href="message_8h.html#a2b9e183ba437b7b3cd7eab5e36423583">00082</a> std::ostream& <a class="code" href="gr__basic__block_8h.html#acb2f610728a7f3cbd51a9a2eb60f059e">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classboost_1_1shared__ptr.html">mb_message_sptr</a> msg)
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 os << *(msg.get());
<a name="l00085"></a>00085 <span class="keywordflow">return</span> os;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_MB_MESSAGE_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="message_8h.html">message.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
>
6583
