📄 a00566.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::InstanceState 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="a00566.html">InstanceState</a></div>
<h1>OpenDDS::DCPS::InstanceState Class Reference</h1><!-- doxytag: class="OpenDDS::DCPS::InstanceState" -->manage the states of a received data instance.
<a href="#_details">More...</a>
<p>
<code>#include <InstanceState.h></code>
<p>
Collaboration diagram for OpenDDS::DCPS::InstanceState:<p><center><img src="a02687.png" border="0" usemap="#a02688" alt="Collaboration graph"></center>
<map name="a02688">
<area href="a00498.html" shape="rect" coords="6,7,248,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="a00035.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="a00566.html#09f21fb381c8efff6d2329be57f5aa64">InstanceState</a> (<a class="el" href="a00498.html">DataReaderImpl</a> *reader, <a class="el" href="a01300.html#eb7ecc890025e01410359d237b2245a5">DDS::InstanceHandle_t</a> handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#09f21fb381c8efff6d2329be57f5aa64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#6030684f5e93c994b7a75a34668c6e2f">~InstanceState</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#6030684f5e93c994b7a75a34668c6e2f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#354390f83fcc2c1b611714f597b44f99">sample_info</a> (::<a class="el" href="a00667.html">DDS::SampleInfo</a> &si, const <a class="el" href="a00645.html">ReceivedDataElement</a> *de)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate the SampleInfo structure. <a href="#354390f83fcc2c1b611714f597b44f99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01300.html#f496592aa1f1bf9a88c12a4a7193be51">DDS::InstanceStateKind</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#9b57b4dd0b0abe19736f6aa9b82623f2">instance_state</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access instance state. <a href="#9b57b4dd0b0abe19736f6aa9b82623f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01300.html#955eff3d3d6208890a9dd0f23f4b4beb">DDS::ViewStateKind</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#ec766d834ef25bc321680e6307cf5f92">view_state</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access view state. <a href="#ec766d834ef25bc321680e6307cf5f92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#df91687970275dab0965f3becd39d6ac">disposed_generation_count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access disposed generation count. <a href="#df91687970275dab0965f3becd39d6ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#bb99318cf732657d62a97f046df38abe">no_writers_generation_count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access no writers generation count. <a href="#bb99318cf732657d62a97f046df38abe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#2ac8e479cff1f62dca2bc91857e258e8">dispose_was_received</a> (const <a class="el" href="a00552.html">PublicationId</a> &writer_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DISPOSE message received for this instance. <a href="#2ac8e479cff1f62dca2bc91857e258e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#2078f012256d142cc0d44ac5bfcf83ed">data_was_received</a> (const <a class="el" href="a00552.html">PublicationId</a> &writer_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data sample received for this instance. <a href="#2078f012256d142cc0d44ac5bfcf83ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#e251f0986e1e29889b5d316a2a28c528">lively</a> (const <a class="el" href="a00552.html">PublicationId</a> &writer_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">LIVELINESS message received for this DataWriter. <a href="#e251f0986e1e29889b5d316a2a28c528"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#694209e42b93017c0eea13d52ea2f79f">accessed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A read or take operation has been performed on this instance. <a href="#694209e42b93017c0eea13d52ea2f79f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#ca9263607030e0ed7a5d13bd667ccfa9">most_recent_generation</a> (<a class="el" href="a00645.html">ReceivedDataElement</a> *item) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#55b5c27e489fccfaf54c2e38c5a0f350">empty</a> (bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DataReader has become empty. <a href="#55b5c27e489fccfaf54c2e38c5a0f350"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#63908de713b24cadf0d51580f512399c">release_if_empty</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#6d07b1267298a9c3a4f48778c9087976">writer_became_dead</a> (const <a class="el" href="a00552.html">PublicationId</a> &writer_id, int num_alive_writers, const ACE_Time_Value &when)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">tell this instance when a DataWriter transitions to NOT_ALIVE <a href="#6d07b1267298a9c3a4f48778c9087976"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#a4fd412daf5e9da240acc88e4d5e4164">unregister_was_received</a> (const <a class="el" href="a00552.html">PublicationId</a> &writer_id)</td></tr>
<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::set< <a class="el" href="a00552.html">PublicationId</a>,<br>
GUID_tKeyLessThan > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#d5024768a232898abd412ed203f394b4">Writers</a></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01300.html#f496592aa1f1bf9a88c12a4a7193be51">DDS::InstanceStateKind</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#3900f29ed342c4ae271d6744d259b794">instance_state_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01300.html#955eff3d3d6208890a9dd0f23f4b4beb">DDS::ViewStateKind</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#369809de6da333df8ea0342ec2095a60">view_state_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#b572fe68cc16d144c38c9ceda683167e">disposed_generation_count_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#3ce14b90f72813f35b009cf78c027473">no_writers_generation_count_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#fd9783f09e8891f56c8004c0905b09aa">no_writers_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#5ee13100ed9949ef0659232bb8e4b359">empty_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00498.html">DataReaderImpl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#2dbb074b234a5ef00428415c3386dd87">reader_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">::<a class="el" href="a01300.html#eb7ecc890025e01410359d237b2245a5">DDS::InstanceHandle_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#847d06f7466db7b6aa6c8eab2d122e25">handle_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00566.html#d5024768a232898abd412ed203f394b4">Writers</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00566.html#6c471fb8fccfefe87506c3aeec21f689">writers_</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
manage the states of a received data instance.
<p>
Provide a mechanism to manage the view state and instance state values for an instance contained within a DataReader. The instance_state and view_state are managed by this class. Accessors are provided to query the current value of each of these states.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="d5024768a232898abd412ed203f394b4"></a><!-- doxytag: member="OpenDDS::DCPS::InstanceState::Writers" ref="d5024768a232898abd412ed203f394b4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::set<<a class="el" href="a00552.html">PublicationId</a>, GUID_tKeyLessThan> <a class="el" href="a00566.html#d5024768a232898abd412ed203f394b4">OpenDDS::DCPS::InstanceState::Writers</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="09f21fb381c8efff6d2329be57f5aa64"></a><!-- doxytag: member="OpenDDS::DCPS::InstanceState::InstanceState" ref="09f21fb381c8efff6d2329be57f5aa64" args="(DataReaderImpl *reader, DDS::InstanceHandle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenDDS::DCPS::InstanceState::InstanceState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00498.html">DataReaderImpl</a> * </td>
<td class="paramname"> <em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01300.html#eb7ecc890025e01410359d237b2245a5">DDS::InstanceHandle_t</a> </td>
<td class="paramname"> <em>handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="6030684f5e93c994b7a75a34668c6e2f"></a><!-- doxytag: member="OpenDDS::DCPS::InstanceState::~InstanceState" ref="6030684f5e93c994b7a75a34668c6e2f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE OpenDDS::DCPS::InstanceState::~InstanceState </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="694209e42b93017c0eea13d52ea2f79f"></a><!-- doxytag: member="OpenDDS::DCPS::InstanceState::accessed" ref="694209e42b93017c0eea13d52ea2f79f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE void OpenDDS::DCPS::InstanceState::accessed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A read or take operation has been performed on this instance.
<p>
</div>
</div><p>
<a class="anchor" name="2078f012256d142cc0d44ac5bfcf83ed"></a><!-- doxytag: member="OpenDDS::DCPS::InstanceState::data_was_received" ref="2078f012256d142cc0d44ac5bfcf83ed" args="(const PublicationId &writer_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_INLINE void OpenDDS::DCPS::InstanceState::data_was_received </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00552.html">PublicationId</a> & </td>
<td class="paramname"> <em>writer_id</em> </td>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -