<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: dtn::PersistentStore 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.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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="navpath"><a class="el" href="namespacedtn.html">dtn</a>::<a class="el" href="classdtn_1_1PersistentStore.html">PersistentStore</a>
</div>
</div>
<div class="contents">
<h1>dtn::PersistentStore Class Reference</h1><!-- doxytag: class="dtn::PersistentStore" --><code>#include <<a class="el" href="PersistentStore_8h-source.html">PersistentStore.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::PersistentStore:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1PersistentStore.png" usemap="#dtn::PersistentStore_map" border="0" alt=""></center>
<map name="dtn::PersistentStore_map">
<area href="classdtn_1_1SQLStore.html" alt="dtn::SQLStore" shape="rect" coords="0,56,120,80">
</map>
</div>
<p>
<a href="classdtn_1_1PersistentStore-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The abstract base class implementing a persistent storage system.
<p>
Specific implementations (i.e. Berkeley DB or SQL) should derive from this class.<p>
TODO: * should the key be an int or a std::string?
<p>Definition at line <a class="el" href="PersistentStore_8h-source.html#l00034">34</a> of file <a class="el" href="PersistentStore_8h-source.html">PersistentStore.h</a>.</p>
<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">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#a978192e43db411366df9d21496034ef">close</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close and flush the store. <a href="#a978192e43db411366df9d21496034ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#5ada8bde2488710e184c0110f9e25d70">get</a> (oasys::SerializableObject *obj, const int key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill in the fields of the object referred to by *obj with the value stored at the given key. <a href="#5ada8bde2488710e184c0110f9e25d70"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#6229ffd0247027c890ba928744d38996">add</a> (oasys::SerializableObject *obj, const int key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Store the object with the given key. <a href="#6229ffd0247027c890ba928744d38996"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#7006bf2e5f1224f23878954832bfd3b6">update</a> (oasys::SerializableObject *obj, const int key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the object with the given key. <a href="#7006bf2e5f1224f23878954832bfd3b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#a61eb5143c8adf19c8d4fe33b26c21ad">del</a> (const int key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the object at the given key. <a href="#a61eb5143c8adf19c8d4fe33b26c21ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#78c30bf1080f18bb2b17601b49ec490b">num_elements</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of elements in the table. <a href="#78c30bf1080f18bb2b17601b49ec490b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#aef07688ef23ad3e0904198cf7ba142a">keys</a> (std::vector< int > *v)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill in the given vector with the keys currently stored in the table. <a href="#aef07688ef23ad3e0904198cf7ba142a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1PersistentStore.html#4c8bb8c85bef382e255f876035cee495">~PersistentStore</a> ()</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4c8bb8c85bef382e255f876035cee495"></a><!-- doxytag: member="dtn::PersistentStore::~PersistentStore" ref="4c8bb8c85bef382e255f876035cee495" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual dtn::PersistentStore::~PersistentStore </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a978192e43db411366df9d21496034ef"></a><!-- doxytag: member="dtn::PersistentStore::close" ref="a978192e43db411366df9d21496034ef" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close and flush the store.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#e658972b34f6e008a90b58b1d97761da">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="5ada8bde2488710e184c0110f9e25d70"></a><!-- doxytag: member="dtn::PersistentStore::get" ref="5ada8bde2488710e184c0110f9e25d70" args="(oasys::SerializableObject *obj, const int key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::get </td>
<td>(</td>
<td class="paramtype">oasys::SerializableObject * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fill in the fields of the object referred to by *obj with the value stored at the given key.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#d6c75ed93ee9f1bad1dd63b782fc55ac">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="6229ffd0247027c890ba928744d38996"></a><!-- doxytag: member="dtn::PersistentStore::add" ref="6229ffd0247027c890ba928744d38996" args="(oasys::SerializableObject *obj, const int key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::add </td>
<td>(</td>
<td class="paramtype">oasys::SerializableObject * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Store the object with the given key.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#a21ab0951e38b471c533401c79dbe087">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="7006bf2e5f1224f23878954832bfd3b6"></a><!-- doxytag: member="dtn::PersistentStore::update" ref="7006bf2e5f1224f23878954832bfd3b6" args="(oasys::SerializableObject *obj, const int key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::update </td>
<td>(</td>
<td class="paramtype">oasys::SerializableObject * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the object with the given key.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#bbaa6642234705adf3fe5a2e0d157bb2">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="a61eb5143c8adf19c8d4fe33b26c21ad"></a><!-- doxytag: member="dtn::PersistentStore::del" ref="a61eb5143c8adf19c8d4fe33b26c21ad" args="(const int key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::del </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete the object at the given key.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#ef53bb4baf876f7d747ad7d0ae3b7889">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="78c30bf1080f18bb2b17601b49ec490b"></a><!-- doxytag: member="dtn::PersistentStore::num_elements" ref="78c30bf1080f18bb2b17601b49ec490b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int dtn::PersistentStore::num_elements </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of elements in the table.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#57f01f62cff0806c2b9a895f8ce6d430">dtn::SQLStore</a>.</p>
</div>
</div><p>
<a class="anchor" name="aef07688ef23ad3e0904198cf7ba142a"></a><!-- doxytag: member="dtn::PersistentStore::keys" ref="aef07688ef23ad3e0904198cf7ba142a" args="(std::vector< int > *v)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void dtn::PersistentStore::keys </td>
<td>(</td>
<td class="paramtype">std::vector< int > * </td>
<td class="paramname"> <em>v</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fill in the given vector with the keys currently stored in the table.
<p>
<p>Implemented in <a class="el" href="classdtn_1_1SQLStore.html#6e58acdb3c6d58d1e8578d6346a0fe74">dtn::SQLStore</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PersistentStore_8h-source.html">PersistentStore.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:55 2008 for DTN Reference Implementation by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
