<!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 Class Reference</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('classgr__message.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_message Class Reference<div class="ingroups"><a class="el" href="group__misc.html">Miscellaneous</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_message" -->
<p>Message class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__message_8h_source.html">gr_message.h</a>></code></p>
<p><a href="classgr__message-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#aad815faeaf8018ca426f9255f9a0eca2">~gr_message</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">arg1</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">arg2</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a820cbc9a5f12eef31bc55256cd7210b8">set_type</a> (long type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#ac5178f4481065285eb4b4bb5f21ada21">set_arg1</a> (double arg1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#ab56c0ea898c120ac37f40bd6d8d838fd">set_arg2</a> (double arg2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#ad8fed3cce61057e489b005feee5a4abe">msg</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a25185e6826e0998e528c79539186c129">length</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a97279d203ce6717b42929cbcc450f927">to_string</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#af043921a9e7cd294c5c2cdac2e97c813">gr_msg_queue</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a83dc2cf4d057989f872bbfde05fdf29c">gr_make_message</a> (long type, double arg1, double arg2, size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">public constructor for <a class="el" href="classgr__message.html" title="Message class.">gr_message</a> <a href="#a83dc2cf4d057989f872bbfde05fdf29c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html#a0d08a592f3998470b652d339d99a7b2a">gr_make_message_from_string</a> (const std::string s, long type, double arg1, double arg2)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Message class. </p>
<p>The ideas and method names for adjustable message length were lifted from the click modular router "Packet" class. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aad815faeaf8018ca426f9255f9a0eca2"></a><!-- doxytag: member="gr_message::~gr_message" ref="aad815faeaf8018ca426f9255f9a0eca2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_message::~gr_message </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a34f11c43ca1e2412b1404a14178d3ccb"></a><!-- doxytag: member="gr_message::arg1" ref="a34f11c43ca1e2412b1404a14178d3ccb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_message::arg1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__message.html#ac5178f4481065285eb4b4bb5f21ada21">set_arg1()</a>.</p>
</div>
</div>
<a class="anchor" id="a03f6058e5f412cabd793117b5bbf093f"></a><!-- doxytag: member="gr_message::arg2" ref="a03f6058e5f412cabd793117b5bbf093f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_message::arg2 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__message.html#ab56c0ea898c120ac37f40bd6d8d838fd">set_arg2()</a>.</p>
</div>
</div>
<a class="anchor" id="a25185e6826e0998e528c79539186c129"></a><!-- doxytag: member="gr_message::length" ref="a25185e6826e0998e528c79539186c129" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t gr_message::length </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad8fed3cce61057e489b005feee5a4abe"></a><!-- doxytag: member="gr_message::msg" ref="ad8fed3cce61057e489b005feee5a4abe" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* gr_message::msg </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5178f4481065285eb4b4bb5f21ada21"></a><!-- doxytag: member="gr_message::set_arg1" ref="ac5178f4481065285eb4b4bb5f21ada21" args="(double arg1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_message::set_arg1 </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__message.html#a34f11c43ca1e2412b1404a14178d3ccb">arg1()</a>.</p>
</div>
</div>
<a class="anchor" id="ab56c0ea898c120ac37f40bd6d8d838fd"></a><!-- doxytag: member="gr_message::set_arg2" ref="ab56c0ea898c120ac37f40bd6d8d838fd" args="(double arg2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_message::set_arg2 </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg2</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__message.html#a03f6058e5f412cabd793117b5bbf093f">arg2()</a>.</p>
</div>
</div>
<a class="anchor" id="a820cbc9a5f12eef31bc55256cd7210b8"></a><!-- doxytag: member="gr_message::set_type" ref="a820cbc9a5f12eef31bc55256cd7210b8" args="(long type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_message::set_type </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__message.html#a7965642c0c2fb586379550a5884b0ee6">type()</a>.</p>
</div>
</div>
<a class="anchor" id="a97279d203ce6717b42929cbcc450f927"></a><!-- doxytag: member="gr_message::to_string" ref="a97279d203ce6717b42929cbcc450f927" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string gr_message::to_string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7965642c0c2fb586379550a5884b0ee6"></a><!-- doxytag: member="gr_message::type" ref="a7965642c0c2fb586379550a5884b0ee6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long gr_message::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__message.html#a820cbc9a5f12eef31bc55256cd7210b8">set_type()</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a83dc2cf4d057989f872bbfde05fdf29c"></a><!-- doxytag: member="gr_message::gr_make_message" ref="a83dc2cf4d057989f872bbfde05fdf29c" args="(long type, double arg1, double arg2, size_t length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> gr_make_message </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>public constructor for <a class="el" href="classgr__message.html" title="Message class.">gr_message</a> </p>
</div>
</div>
<a class="anchor" id="a0d08a592f3998470b652d339d99a7b2a"></a><!-- doxytag: member="gr_message::gr_make_message_from_string" ref="a0d08a592f3998470b652d339d99a7b2a" args="(const std::string s, long type, double arg1, double arg2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> gr_make_message_from_string </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>arg2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af043921a9e7cd294c5c2cdac2e97c813"></a><!-- doxytag: member="gr_message::gr_msg_queue" ref="af043921a9e7cd294c5c2cdac2e97c813" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgr__msg__queue.html">gr_msg_queue</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__message_8h_source.html">gr_message.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__message.html">gr_message</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
>
1478
