<!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: mb_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('classmb__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>mb_message Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="mb_message" --> <p><code>#include <<a class="el" href="message_8h_source.html">message.h</a>></code></p> <p><a href="classmb__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="classmb__message.html#a7be7eb5f450f58c224cb57a53b96d07d">~mb_message</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#adf399eafd8534483bfabd891799fa7c1">signal</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#a0ba7b5ed6443e5c14d5718d32e3b8420">data</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#aed19f1c911c2fbe0d6ad1290a0dc8be6">metadata</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#ac86731a0308fd9144dfa606e58b48873">priority</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">port_id</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#a6f0f3d212ff6a8945ca4229489681ea3">set_port_id</a> (<a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> port_id)</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="classmb__message.html#a682d496c07a35ef2e0f7e652ce238c5f">mb_msg_queue</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">mb_message_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__message.html#ae4a799d3192b1f59eda195787d3725f7">mb_make_message</a> (<a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> signal, <a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> data, <a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> metadata, <a class="el" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> priority)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">construct a message and return <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> <a href="#ae4a799d3192b1f59eda195787d3725f7"></a><br/></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7be7eb5f450f58c224cb57a53b96d07d"></a><!-- doxytag: member="mb_message::~mb_message" ref="a7be7eb5f450f58c224cb57a53b96d07d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mb_message::~mb_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="a0ba7b5ed6443e5c14d5718d32e3b8420"></a><!-- doxytag: member="mb_message::data" ref="a0ba7b5ed6443e5c14d5718d32e3b8420" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> mb_message::data </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="aed19f1c911c2fbe0d6ad1290a0dc8be6"></a><!-- doxytag: member="mb_message::metadata" ref="aed19f1c911c2fbe0d6ad1290a0dc8be6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> mb_message::metadata </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="a0e23a3621d62edbe2bbf6187e1926b1d"></a><!-- doxytag: member="mb_message::port_id" ref="a0e23a3621d62edbe2bbf6187e1926b1d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> mb_message::port_id </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="classmb__message.html#a6f0f3d212ff6a8945ca4229489681ea3">set_port_id()</a>.</p> </div> </div> <a class="anchor" id="ac86731a0308fd9144dfa606e58b48873"></a><!-- doxytag: member="mb_message::priority" ref="ac86731a0308fd9144dfa606e58b48873" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> mb_message::priority </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="a6f0f3d212ff6a8945ca4229489681ea3"></a><!-- doxytag: member="mb_message::set_port_id" ref="a6f0f3d212ff6a8945ca4229489681ea3" args="(pmt_t port_id)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mb_message::set_port_id </td> <td>(</td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td> <td class="paramname"><em>port_id</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classmb__message.html#a0e23a3621d62edbe2bbf6187e1926b1d">port_id()</a>.</p> </div> </div> <a class="anchor" id="adf399eafd8534483bfabd891799fa7c1"></a><!-- doxytag: member="mb_message::signal" ref="adf399eafd8534483bfabd891799fa7c1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> mb_message::signal </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ae4a799d3192b1f59eda195787d3725f7"></a><!-- doxytag: member="mb_message::mb_make_message" ref="ae4a799d3192b1f59eda195787d3725f7" args="(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">mb_message_sptr</a> mb_make_message </td> <td>(</td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td> <td class="paramname"><em>signal</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td> <td class="paramname"><em>metadata</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> </td> <td class="paramname"><em>priority</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>construct a message and return <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">signal</td><td>identifier of the message </td></tr> <tr><td class="paramname">data</td><td>the data to be operated on </td></tr> <tr><td class="paramname">metadata</td><td>information about the data </td></tr> <tr><td class="paramname">priority</td><td>urgency </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a682d496c07a35ef2e0f7e652ce238c5f"></a><!-- doxytag: member="mb_message::mb_msg_queue" ref="a682d496c07a35ef2e0f7e652ce238c5f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classmb__msg__queue.html">mb_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="message_8h_source.html">message.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classmb__message.html">mb_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>