📄 a00637.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>OpenDDS: OpenDDS::DCPS::QueueRemoveVisitor Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a01301.html">OpenDDS</a>::<a class="el" href="a01275.html">DCPS</a>::<a class="el" href="a00637.html">QueueRemoveVisitor</a></div>
<h1>OpenDDS::DCPS::QueueRemoveVisitor Class Reference</h1><!-- doxytag: class="OpenDDS::DCPS::QueueRemoveVisitor" --><!-- doxytag: inherits="OpenDDS::DCPS::BasicQueueVisitor" --><code>#include <QueueRemoveVisitor.h></code>
<p>
Inheritance diagram for OpenDDS::DCPS::QueueRemoveVisitor:<p><center><img src="a02801.png" border="0" usemap="#a02802" alt="Inheritance graph"></center>
<map name="a02802">
<area href="a00478.html" shape="rect" coords="6,7,566,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for OpenDDS::DCPS::QueueRemoveVisitor:<p><center><img src="a02803.png" border="0" usemap="#a02804" alt="Collaboration graph"></center>
<map name="a02804">
<area href="a00478.html" shape="rect" coords="5,98,565,122" alt="">
<area href="a00552.html" shape="rect" coords="589,98,771,122" alt="">
<area href="a00542.html" shape="rect" coords="580,7,780,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="a00080.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#ac44832161ff0007e1480d139e66567f">QueueRemoveVisitor</a> (const ACE_Message_Block *sample)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#4247c1be5e885b732060a0c86d7a1274">QueueRemoveVisitor</a> (<a class="el" href="a00552.html">RepoId</a> pub_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to remove all control samples with the specified pub_id. <a href="#4247c1be5e885b732060a0c86d7a1274"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#165779810891633c0bd7c9f39de102e1">~QueueRemoveVisitor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#7e40beddad6db70763d962f57e73b2e4">visit_element_remove</a> (<a class="el" href="a00751.html">TransportQueueElement</a> *element, int &remove)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#52dea229a615926b004b39ce7e21585b">status</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#b51e9b8e10af03920f3a45e85e96d6b7">removed_bytes</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const ACE_Message_Block * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#6a292c79a076eff1c14dcd0cf8960b07">sample_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sample that needs to be removed. <a href="#6a292c79a076eff1c14dcd0cf8960b07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00552.html">RepoId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#1a40fb45645b2348cd56df04d878aefe">pub_id_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The publisher_id of the control samples to be removed. <a href="#1a40fb45645b2348cd56df04d878aefe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#b7cdaf547a90529ef5de426a866decc0">status_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the status of our visit. <a href="#b7cdaf547a90529ef5de426a866decc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00637.html#5ca632cf65212278d209d4968e48bb10">removed_bytes_</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ac44832161ff0007e1480d139e66567f"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor" ref="ac44832161ff0007e1480d139e66567f" args="(const ACE_Message_Block *sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor </td>
<td>(</td>
<td class="paramtype">const ACE_Message_Block * </td>
<td class="paramname"> <em>sample</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
In order to construct a <a class="el" href="a00637.html">QueueRemoveVisitor</a>, it must be provided with the DataSampleListElement* (used as an identifier) that should be removed from the BasicQueue<T> (the one this visitor will visit when it is passed-in to a <a class="el" href="a00473.html#2932810b6bcfeec9856260a36676aaa7">BasicQueue<T>::accept_remove_visitor()</a> invocation).
</div>
</div><p>
<a class="anchor" name="4247c1be5e885b732060a0c86d7a1274"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor" ref="4247c1be5e885b732060a0c86d7a1274" args="(RepoId pub_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00552.html">RepoId</a> </td>
<td class="paramname"> <em>pub_id</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to remove all control samples with the specified pub_id.
<p>
</div>
</div><p>
<a class="anchor" name="165779810891633c0bd7c9f39de102e1"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::~QueueRemoveVisitor" ref="165779810891633c0bd7c9f39de102e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenDDS::DCPS::QueueRemoveVisitor::~QueueRemoveVisitor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b51e9b8e10af03920f3a45e85e96d6b7"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes" ref="b51e9b8e10af03920f3a45e85e96d6b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE int OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="52dea229a615926b004b39ce7e21585b"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::status" ref="52dea229a615926b004b39ce7e21585b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE int OpenDDS::DCPS::QueueRemoveVisitor::status </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessor for the status. Called after this visitor object has been passed to <a class="el" href="a00473.html#2932810b6bcfeec9856260a36676aaa7">BasicQueue<T>::accept_remove_visitor()</a>.
</div>
</div><p>
<a class="anchor" name="7e40beddad6db70763d962f57e73b2e4"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::visit_element_remove" ref="7e40beddad6db70763d962f57e73b2e4" args="(TransportQueueElement *element, int &remove)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OpenDDS::DCPS::QueueRemoveVisitor::visit_element_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00751.html">TransportQueueElement</a> * </td>
<td class="paramname"> <em>element</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>remove</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The <a class="el" href="a00473.html#2932810b6bcfeec9856260a36676aaa7">BasicQueue<T>::accept_remove_visitor()</a> method will call this <a class="el" href="a00637.html#7e40beddad6db70763d962f57e73b2e4">visit_element_remove()</a> method for each element in the queue.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1a40fb45645b2348cd56df04d878aefe"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::pub_id_" ref="1a40fb45645b2348cd56df04d878aefe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00552.html">RepoId</a> <a class="el" href="a00637.html#1a40fb45645b2348cd56df04d878aefe">OpenDDS::DCPS::QueueRemoveVisitor::pub_id_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The publisher_id of the control samples to be removed.
<p>
</div>
</div><p>
<a class="anchor" name="5ca632cf65212278d209d4968e48bb10"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes_" ref="5ca632cf65212278d209d4968e48bb10" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00637.html#5ca632cf65212278d209d4968e48bb10">OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="6a292c79a076eff1c14dcd0cf8960b07"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::sample_" ref="6a292c79a076eff1c14dcd0cf8960b07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const ACE_Message_Block* <a class="el" href="a00637.html#6a292c79a076eff1c14dcd0cf8960b07">OpenDDS::DCPS::QueueRemoveVisitor::sample_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The sample that needs to be removed.
<p>
</div>
</div><p>
<a class="anchor" name="b7cdaf547a90529ef5de426a866decc0"></a><!-- doxytag: member="OpenDDS::DCPS::QueueRemoveVisitor::status_" ref="b7cdaf547a90529ef5de426a866decc0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00637.html#b7cdaf547a90529ef5de426a866decc0">OpenDDS::DCPS::QueueRemoveVisitor::status_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Holds the status of our visit.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00971.html">QueueRemoveVisitor.h</a><li><a class="el" href="a00970.html">QueueRemoveVisitor.cpp</a><li><a class="el" href="a00972.html">QueueRemoveVisitor.inl</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Nov 7 09:37:42 2008 for OpenDDS by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -