<!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: gr_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('gr__message_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_message.h</h1> </div>
</div>
<div class="contents">
<a href="gr__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 2005 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</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef INCLUDED_GR_MESSAGE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_MESSAGE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="gr__types_8h.html">gr_types.h</a>></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <string></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__message.html" title="Message class.">gr_message</a>;
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<gr_message></a> <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a>;
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">/*!</span>
<a name="l00032"></a>00032 <span class="comment"> * \brief public constructor for gr_message</span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a>00034 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a>
<a name="l00035"></a>00035 <a class="code" href="gr__message_8h.html#aeb98b77a603214cdc7da6b4879fc3706" title="public constructor for gr_message">gr_make_message</a>(<span class="keywordtype">long</span> <a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a> = 0, <span class="keywordtype">double</span> <a class="code" href="gc__spu__macs_8h.html#a489500f7b5cfd21fa6730e3a56f1c1f7">arg1</a> = 0, <span class="keywordtype">double</span> <a class="code" href="gc__spu__macs_8h.html#a3ad2018792b545e1b82249aeb6a16d43">arg2</a> = 0, <span class="keywordtype">size_t</span> <a class="code" href="classgr__message.html#a25185e6826e0998e528c79539186c129">length</a> = 0);
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a>
<a name="l00038"></a>00038 <a class="code" href="gr__message_8h.html#a474f0f36bcbf4045a4fbb23f0093541a">gr_make_message_from_string</a>(<span class="keyword">const</span> std::string s, <span class="keywordtype">long</span> <a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a> = 0, <span class="keywordtype">double</span> <a class="code" href="gc__spu__macs_8h.html#a489500f7b5cfd21fa6730e3a56f1c1f7">arg1</a> = 0, <span class="keywordtype">double</span> <a class="code" href="gc__spu__macs_8h.html#a3ad2018792b545e1b82249aeb6a16d43">arg2</a> = 0);
<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 Message class.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * \ingroup misc</span>
<a name="l00044"></a>00044 <span class="comment"> * The ideas and method names for adjustable message length were</span>
<a name="l00045"></a>00045 <span class="comment"> * lifted from the click modular router "Packet" class.</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="classgr__message.html">00047</a> <span class="keyword">class </span><a class="code" href="classgr__message.html" title="Message class.">gr_message</a> {
<a name="l00048"></a>00048 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> d_next; <span class="comment">// link field for msg queue</span>
<a name="l00049"></a>00049 <span class="keywordtype">long</span> d_type; <span class="comment">// type of the message</span>
<a name="l00050"></a>00050 <span class="keywordtype">double</span> d_arg1; <span class="comment">// optional arg1</span>
<a name="l00051"></a>00051 <span class="keywordtype">double</span> d_arg2; <span class="comment">// optional arg2</span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_buf_start; <span class="comment">// start of allocated buffer</span>
<a name="l00054"></a>00054 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_msg_start; <span class="comment">// where the msg starts</span>
<a name="l00055"></a>00055 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_msg_end; <span class="comment">// one beyond end of msg</span>
<a name="l00056"></a>00056 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_buf_end; <span class="comment">// one beyond end of allocated buffer</span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <a class="code" href="classgr__message.html" title="Message class.">gr_message</a> (<span class="keywordtype">long</span> <a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a>, <span class="keywordtype">double</span> <a class="code" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">arg1</a>, <span class="keywordtype">double</span> <a class="code" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">arg2</a>, <span class="keywordtype">size_t</span> <a class="code" href="classgr__message.html#a25185e6826e0998e528c79539186c129">length</a>);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a>
<a name="l00061"></a>00061 <a class="code" href="classgr__message.html#a83dc2cf4d057989f872bbfde05fdf29c" title="public constructor for gr_message">gr_make_message</a> (<span class="keywordtype">long</span> type, <span class="keywordtype">double</span> arg1, <span class="keywordtype">double</span> arg2, <span class="keywordtype">size_t</span> length);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a>
<a name="l00064"></a>00064 <a class="code" href="classgr__message.html#a0d08a592f3998470b652d339d99a7b2a">gr_make_message_from_string</a> (<span class="keyword">const</span> std::string s, <span class="keywordtype">long</span> type, <span class="keywordtype">double</span> arg1, <span class="keywordtype">double</span> arg2);
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="classgr__message.html#af043921a9e7cd294c5c2cdac2e97c813">00066</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgr__msg__queue.html" title="thread-safe message queue">gr_msg_queue</a>;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf_data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_buf_start; }
<a name="l00069"></a>00069 <span class="keywordtype">size_t</span> buf_len()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_buf_end - d_buf_start; }
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">public</span>:
<a name="l00072"></a>00072 <a class="code" href="classgr__message.html#aad815faeaf8018ca426f9255f9a0eca2">~gr_message</a> ();
<a name="l00073"></a>00073
<a name="l00074"></a><a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">00074</a> <span class="keywordtype">long</span> <a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_type; }
<a name="l00075"></a><a class="code" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">00075</a> <span class="keywordtype">double</span> <a class="code" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">arg1</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_arg1; }
<a name="l00076"></a><a class="code" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">00076</a> <span class="keywordtype">double</span> <a class="code" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">arg2</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_arg2; }
<a name="l00077"></a>00077
<a name="l00078"></a><a class="code" href="classgr__message.html#a820cbc9a5f12eef31bc55256cd7210b8">00078</a> <span class="keywordtype">void</span> <a class="code" href="classgr__message.html#a820cbc9a5f12eef31bc55256cd7210b8">set_type</a>(<span class="keywordtype">long</span> type) { d_type = <a class="code" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a>; }
<a name="l00079"></a><a class="code" href="classgr__message.html#ac5178f4481065285eb4b4bb5f21ada21">00079</a> <span class="keywordtype">void</span> <a class="code" href="classgr__message.html#ac5178f4481065285eb4b4bb5f21ada21">set_arg1</a>(<span class="keywordtype">double</span> arg1) { d_arg1 = <a class="code" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">arg1</a>; }
<a name="l00080"></a><a class="code" href="classgr__message.html#ab56c0ea898c120ac37f40bd6d8d838fd">00080</a> <span class="keywordtype">void</span> <a class="code" href="classgr__message.html#ab56c0ea898c120ac37f40bd6d8d838fd">set_arg2</a>(<span class="keywordtype">double</span> arg2) { d_arg2 = <a class="code" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">arg2</a>; }
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classgr__message.html#ad8fed3cce61057e489b005feee5a4abe">00082</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="classgr__message.html#ad8fed3cce61057e489b005feee5a4abe">msg</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_msg_start; }
<a name="l00083"></a><a class="code" href="classgr__message.html#a25185e6826e0998e528c79539186c129">00083</a> <span class="keywordtype">size_t</span> <a class="code" href="classgr__message.html#a25185e6826e0998e528c79539186c129">length</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_msg_end - d_msg_start; }
<a name="l00084"></a>00084 std::string <a class="code" href="classgr__message.html#a97279d203ce6717b42929cbcc450f927">to_string</a>() <span class="keyword">const</span>;
<a name="l00085"></a>00085
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">long</span> <a class="code" href="gr__message_8h.html#ad7f5806b2f1c84a862e91f80210c40eb">gr_message_ncurrently_allocated</a> ();
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_MESSAGE_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__message_8h.html">gr_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
>
4618
