/usr/share/doc/mia-2.0/libdoc/classCDatapool.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>CDatapool Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CDatapool Class Reference<div class="ingroups"><a class="el" href="group__io.html">Input/output of files</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>temporary data storage to avoid storing on disk
<a href="classCDatapool.html#details">More...</a></p>
<p><code>#include <<a class="el" href="datapool_8hh_source.html">mia/core/datapool.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab10d6c3a8e1e68d3ef66fc94a877387e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#ab10d6c3a8e1e68d3ef66fc94a877387e">add</a> (const std::string &key, boost::any value)</td></tr>
<tr class="separator:ab10d6c3a8e1e68d3ef66fc94a877387e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a4d541004fa7f9cbdff6c5deb2b3a03"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#a0a4d541004fa7f9cbdff6c5deb2b3a03">clear</a> ()</td></tr>
<tr class="separator:a0a4d541004fa7f9cbdff6c5deb2b3a03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac853b4fbdf667ba88fb0eb9728d4992e"><td class="memItemLeft" align="right" valign="top">boost::any </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#ac853b4fbdf667ba88fb0eb9728d4992e">get</a> (const std::string &key) const </td></tr>
<tr class="separator:ac853b4fbdf667ba88fb0eb9728d4992e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f9a253456bd80372b5d9fa05e4d9df2"><td class="memItemLeft" align="right" valign="top">boost::any </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#a8f9a253456bd80372b5d9fa05e4d9df2">get_and_remove</a> (const std::string &key)</td></tr>
<tr class="separator:a8f9a253456bd80372b5d9fa05e4d9df2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2f34d44fd0185d7d03a141641318c87"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#aa2f34d44fd0185d7d03a141641318c87">has_key</a> (const std::string &key) const </td></tr>
<tr class="separator:aa2f34d44fd0185d7d03a141641318c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a337d92dfb04a643bc86e11e04f90cf38"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#a337d92dfb04a643bc86e11e04f90cf38">has_unused_data</a> () const </td></tr>
<tr class="separator:a337d92dfb04a643bc86e11e04f90cf38"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5c0ce5179ed6ee84c929c3e200bb09ea"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCDatapool.html">CDatapool</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatapool.html#a5c0ce5179ed6ee84c929c3e200bb09ea">instance</a> ()</td></tr>
<tr class="separator:a5c0ce5179ed6ee84c929c3e200bb09ea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>temporary data storage to avoid storing on disk </p>
<p>This class implements a data storage pool as a singelton that can be used to store some data temporarly like if it would be stored on disk. Each IO plugin automatically defines an interface to store in and load from this pool. The extension, by which this behaviour is triggered is ".@".</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd><p class="startdd">add delete key function, </p>
<p>add automatic key generation </p>
<p class="enddd">(maybe) all plugins that load data should load to the pool first to enable loading from temporarly generated data </p>
</dd></dl>
<p>Definition at line <a class="el" href="datapool_8hh_source.html#l00050">50</a> of file <a class="el" href="datapool_8hh_source.html">datapool.hh</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab10d6c3a8e1e68d3ef66fc94a877387e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDatapool::add </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::any </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add some data to the pool, if the key already exists, the value is replaced </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>unique identifier </td></tr>
<tr><td class="paramname">value</td><td>value to be stored </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0a4d541004fa7f9cbdff6c5deb2b3a03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDatapool::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all stored data from the pool. </p>
</div>
</div>
<a class="anchor" id="ac853b4fbdf667ba88fb0eb9728d4992e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::any CDatapool::get </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key of data to be retrieved </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value indexed by key, and throws <em>invalid</em> argument if value not exists </dd></dl>
<p>Referenced by <a class="el" href="delayedparameter_8hh_source.html#l00088">TDelayedParameter< T >::get()</a>.</p>
</div>
</div>
<a class="anchor" id="a8f9a253456bd80372b5d9fa05e4d9df2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::any CDatapool::get_and_remove </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets some data and remove this data from the pool </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key of data to be retrieved </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value indexed by key, and throws <em>invalid</em> argument if value not exists </dd></dl>
</div>
</div>
<a class="anchor" id="aa2f34d44fd0185d7d03a141641318c87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CDatapool::has_key </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if key exists in pool and <em>false</em> if not </dd></dl>
<p>Referenced by <a class="el" href="delayedparameter_8hh_source.html#l00098">TDelayedParameter< T >::pool_has_key()</a>.</p>
</div>
</div>
<a class="anchor" id="a337d92dfb04a643bc86e11e04f90cf38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CDatapool::has_unused_data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>function to be used for debugging purpouses </p>
<dl class="section return"><dt>Returns</dt><dd>true if the pool has some data that was not uses </dd></dl>
</div>
</div>
<a class="anchor" id="a5c0ce5179ed6ee84c929c3e200bb09ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCDatapool.html">CDatapool</a>& CDatapool::instance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the unique instance of the data pool </dd></dl>
<p>Referenced by <a class="el" href="delayedparameter_8hh_source.html#l00088">TDelayedParameter< T >::get()</a>, and <a class="el" href="delayedparameter_8hh_source.html#l00098">TDelayedParameter< T >::pool_has_key()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="datapool_8hh_source.html">datapool.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|