<!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_port 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__port.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>mb_port Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="mb_port" -->
<p>Abstract port characteristics.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="port_8h_source.html">port.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mb_port:</div>
<div class="dyncontent">
<div class="center"><img src="classmb__port__inherit__graph.png" border="0" usemap="#mb__port_inherit__map" alt="Inheritance graph"/></div>
<map name="mb__port_inherit__map" id="mb__port_inherit__map">
<area shape="rect" id="node3" href="classmb__port__simple.html" title="Concrete port realization." alt="" coords="5,83,120,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmb__port-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">port_type_t</a> { <a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7afbf7726fc08e0cdad4236ba04e456ac0">EXTERNAL</a>,
<a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7a25099810b70e3bd22435edcb3d945971">RELAY</a>,
<a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7adbe27e3c2f0de021106128f949ac3d5a">INTERNAL</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>port classification </p>
<a href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#a6e7d2167a9469bc8fb032273ef89a34e">port_name</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__port.html#a7f48e9e8cd3c230835ba4d8f008a708c">port_symbol</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__port.html#a9897e91d06be233669a0e5ee78becd77">protocol_class</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#ad18c83bd74aaa1e1f686a37d056a1f74">conjugated</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">port_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#a9f19e3f53b1fb461f48848c9187b177c">port_type</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__port.html#a065353719c1a2c6ba3defbc98738054c">incoming_message_set</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__port.html#a92d36c2407c7ee6c85ad27876ba47f19">outgoing_message_set</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#ad5ed1cc802a4ddaca91f852b810e2b81">~mb_port</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#ad8b9db98bc7588b3f7ba87dcb56fa29d">send</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="pmt_8h.html#acaaedbc8f510c728577f7f29d26f33d9">PMT_F</a>, <a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> metadata=<a class="el" href="pmt_8h.html#acaaedbc8f510c728577f7f29d26f33d9">PMT_F</a>, <a class="el" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> priority=<a class="el" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">MB_PRI_DEFAULT</a>)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a message <a href="#ad8b9db98bc7588b3f7ba87dcb56fa29d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#aea29fb7a1ec65c2e924a21fd3736fdfa">invalidate_cache</a> ()=0</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#a4a8bc91c46289022e87b42a9b1962fe5">mb_port</a> (<a class="el" href="classmb__mblock.html">mb_mblock</a> *mblock, const std::string &port_name, const std::string &protocol_class_name, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> conjugated, <a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">mb_port::port_type_t</a> port_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmb__mblock.html">mb_mblock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#aa6e12c7f0acccd82a9cbe0e54554b620">mblock</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmb__mblock.html">mb_mblock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">d_mblock</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract port characteristics. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ab7f3f63c496d0de66461f09320bbaaa7"></a><!-- doxytag: member="mb_port::port_type_t" ref="ab7f3f63c496d0de66461f09320bbaaa7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">mb_port::port_type_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>port classification </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ab7f3f63c496d0de66461f09320bbaaa7afbf7726fc08e0cdad4236ba04e456ac0"></a><!-- doxytag: member="EXTERNAL" ref="ab7f3f63c496d0de66461f09320bbaaa7afbf7726fc08e0cdad4236ba04e456ac0" args="" -->EXTERNAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab7f3f63c496d0de66461f09320bbaaa7a25099810b70e3bd22435edcb3d945971"></a><!-- doxytag: member="RELAY" ref="ab7f3f63c496d0de66461f09320bbaaa7a25099810b70e3bd22435edcb3d945971" args="" -->RELAY</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab7f3f63c496d0de66461f09320bbaaa7adbe27e3c2f0de021106128f949ac3d5a"></a><!-- doxytag: member="INTERNAL" ref="ab7f3f63c496d0de66461f09320bbaaa7adbe27e3c2f0de021106128f949ac3d5a" args="" -->INTERNAL</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4a8bc91c46289022e87b42a9b1962fe5"></a><!-- doxytag: member="mb_port::mb_port" ref="a4a8bc91c46289022e87b42a9b1962fe5" args="(mb_mblock *mblock, const std::string &port_name, const std::string &protocol_class_name, bool conjugated, mb_port::port_type_t port_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mb_port::mb_port </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmb__mblock.html">mb_mblock</a> * </td>
<td class="paramname"><em>mblock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>port_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>protocol_class_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>conjugated</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">mb_port::port_type_t</a> </td>
<td class="paramname"><em>port_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad5ed1cc802a4ddaca91f852b810e2b81"></a><!-- doxytag: member="mb_port::~mb_port" ref="ad5ed1cc802a4ddaca91f852b810e2b81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mb_port::~mb_port </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad18c83bd74aaa1e1f686a37d056a1f74"></a><!-- doxytag: member="mb_port::conjugated" ref="ad18c83bd74aaa1e1f686a37d056a1f74" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> mb_port::conjugated </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="a065353719c1a2c6ba3defbc98738054c"></a><!-- doxytag: member="mb_port::incoming_message_set" ref="a065353719c1a2c6ba3defbc98738054c" 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_port::incoming_message_set </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aea29fb7a1ec65c2e924a21fd3736fdfa"></a><!-- doxytag: member="mb_port::invalidate_cache" ref="aea29fb7a1ec65c2e924a21fd3736fdfa" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mb_port::invalidate_cache </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classmb__port__simple.html#a0eacb5feaf406c95b88ef40bdd655e66">mb_port_simple</a>.</p>
</div>
</div>
<a class="anchor" id="aa6e12c7f0acccd82a9cbe0e54554b620"></a><!-- doxytag: member="mb_port::mblock" ref="aa6e12c7f0acccd82a9cbe0e54554b620" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmb__mblock.html">mb_mblock</a>* mb_port::mblock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">d_mblock</a>.</p>
</div>
</div>
<a class="anchor" id="a92d36c2407c7ee6c85ad27876ba47f19"></a><!-- doxytag: member="mb_port::outgoing_message_set" ref="a92d36c2407c7ee6c85ad27876ba47f19" 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_port::outgoing_message_set </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6e7d2167a9469bc8fb032273ef89a34e"></a><!-- doxytag: member="mb_port::port_name" ref="a6e7d2167a9469bc8fb032273ef89a34e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mb_port::port_name </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="a7f48e9e8cd3c230835ba4d8f008a708c"></a><!-- doxytag: member="mb_port::port_symbol" ref="a7f48e9e8cd3c230835ba4d8f008a708c" 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_port::port_symbol </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="a9f19e3f53b1fb461f48848c9187b177c"></a><!-- doxytag: member="mb_port::port_type" ref="a9f19e3f53b1fb461f48848c9187b177c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">port_type_t</a> mb_port::port_type </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="a9897e91d06be233669a0e5ee78becd77"></a><!-- doxytag: member="mb_port::protocol_class" ref="a9897e91d06be233669a0e5ee78becd77" 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_port::protocol_class </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="ad8b9db98bc7588b3f7ba87dcb56fa29d"></a><!-- doxytag: member="mb_port::send" ref="ad8b9db98bc7588b3f7ba87dcb56fa29d" args="(pmt_t signal, pmt_t data=PMT_F, pmt_t metadata=PMT_F, mb_pri_t priority=MB_PRI_DEFAULT)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mb_port::send </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> = <code><a class="el" href="pmt_8h.html#acaaedbc8f510c728577f7f29d26f33d9">PMT_F</a></code>, </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> = <code><a class="el" href="pmt_8h.html#acaaedbc8f510c728577f7f29d26f33d9">PMT_F</a></code>, </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> = <code><a class="el" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">MB_PRI_DEFAULT</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>send a message </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">signal</td><td>the event name </td></tr>
<tr><td class="paramname">data</td><td>optional data </td></tr>
<tr><td class="paramname">metadata</td><td>optional metadata </td></tr>
<tr><td class="paramname">priority</td><td>the urgency at which the message is sent </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classmb__port__simple.html#afab277f3a993813838b72c5774b2c2f6">mb_port_simple</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab91541cfc8cbae3eab45257ae447e84c"></a><!-- doxytag: member="mb_port::d_mblock" ref="ab91541cfc8cbae3eab45257ae447e84c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmb__mblock.html">mb_mblock</a>* <a class="el" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">mb_port::d_mblock</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classmb__port.html#aa6e12c7f0acccd82a9cbe0e54554b620">mblock()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="port_8h_source.html">port.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classmb__port.html">mb_port</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
>
2410
