/usr/share/doc/mia-2.0/libdoc/classTDelayedParameter.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 | <!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>TDelayedParameter< T > Class Template 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> </div>
<div class="headertitle">
<div class="title">TDelayedParameter< T > Class Template Reference<div class="ingroups"><a class="el" href="group__cmdline.html">Command line and parameter parsing</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A parameter proxy object with a key to identify it.
<a href="classTDelayedParameter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="delayedparameter_8hh_source.html">mia/core/delayedparameter.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:a34b3c452af6090b7b5c9ba5f6a4b00fb"><td class="memItemLeft" align="right" valign="top">const T </td><td class="memItemRight" valign="bottom"><a class="el" href="classTDelayedParameter.html#a34b3c452af6090b7b5c9ba5f6a4b00fb">get</a> () const </td></tr>
<tr class="separator:a34b3c452af6090b7b5c9ba5f6a4b00fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a598e37cd545c2afa9fc4d60251a2a95b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTDelayedParameter.html#a598e37cd545c2afa9fc4d60251a2a95b">key_is_valid</a> () const </td></tr>
<tr class="separator:a598e37cd545c2afa9fc4d60251a2a95b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf38a7e9e0aa27a8d907ee7253f28ffc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTDelayedParameter.html#acf38a7e9e0aa27a8d907ee7253f28ffc">pool_has_key</a> () const </td></tr>
<tr class="separator:acf38a7e9e0aa27a8d907ee7253f28ffc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd3dd821ac7508aa5a6c683d2bcf0e86"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTDelayedParameter.html#afd3dd821ac7508aa5a6c683d2bcf0e86">TDelayedParameter</a> ()=default</td></tr>
<tr class="separator:afd3dd821ac7508aa5a6c683d2bcf0e86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f4fd4eaa0754b4e5d7201167353b974"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTDelayedParameter.html#a5f4fd4eaa0754b4e5d7201167353b974">TDelayedParameter</a> (const std::string &key)</td></tr>
<tr class="separator:a5f4fd4eaa0754b4e5d7201167353b974"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br/>
class TDelayedParameter< T ></h3>
<p>A parameter proxy object with a key to identify it. </p>
<p>This template is used to hold reference to data that may not yet be available and will be/or is stored in the internal data pool. One axample for its usage is to pass parameters to the filters in a filter pipeline that are only created after the filters itself is created. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCDatapool.html" title="temporary data storage to avoid storing on disk ">CDatapool</a>. </dd></dl>
<p>Definition at line <a class="el" href="delayedparameter_8hh_source.html#l00046">46</a> of file <a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="afd3dd821ac7508aa5a6c683d2bcf0e86"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTDelayedParameter.html">TDelayedParameter</a>< T >::<a class="el" href="classTDelayedParameter.html">TDelayedParameter</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5f4fd4eaa0754b4e5d7201167353b974"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTDelayedParameter.html">TDelayedParameter</a>< T >::<a class="el" href="classTDelayedParameter.html">TDelayedParameter</a> </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>Assosiate the parameter with its key in the data pool. At creation time, the data doesn't have to be available in the data pool. </p>
<p>Definition at line <a class="el" href="delayedparameter_8hh_source.html#l00081">81</a> of file <a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a34b3c452af6090b7b5c9ba5f6a4b00fb"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">const T <a class="el" href="classTDelayedParameter.html">TDelayedParameter</a>< T >::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data assosiated with this parameter. Throws <em>std::invalid_argument</em> if the key is not available in the data pool </p>
<p>Definition at line <a class="el" href="delayedparameter_8hh_source.html#l00088">88</a> of file <a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a>.</p>
<p>References <a class="el" href="classCDatapool.html#ac853b4fbdf667ba88fb0eb9728d4992e">CDatapool::get()</a>, and <a class="el" href="classCDatapool.html#a5c0ce5179ed6ee84c929c3e200bb09ea">CDatapool::instance()</a>.</p>
</div>
</div>
<a class="anchor" id="a598e37cd545c2afa9fc4d60251a2a95b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classTDelayedParameter.html">TDelayedParameter</a>< T >::key_is_valid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this key is actually valid (i.e. not empty) </p>
<dl class="section return"><dt>Returns</dt><dd>true if the key is valid </dd></dl>
<p>Definition at line <a class="el" href="delayedparameter_8hh_source.html#l00105">105</a> of file <a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a>.</p>
</div>
</div>
<a class="anchor" id="acf38a7e9e0aa27a8d907ee7253f28ffc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classTDelayedParameter.html">TDelayedParameter</a>< T >::pool_has_key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the key is available in the data bool. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the key is available </dd></dl>
<p>Definition at line <a class="el" href="delayedparameter_8hh_source.html#l00098">98</a> of file <a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a>.</p>
<p>References <a class="el" href="classCDatapool.html#aa2f34d44fd0185d7d03a141641318c87">CDatapool::has_key()</a>, and <a class="el" href="classCDatapool.html#a5c0ce5179ed6ee84c929c3e200bb09ea">CDatapool::instance()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="delayedparameter_8hh_source.html">delayedparameter.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:10 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>
|