/usr/share/camitk-4.0/apidoc/html/classMethod.html is in libcamitk4-doc 4.0.4-2.
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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Computer Assited Medical Intervention Tool Kit: Method 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="camitk-small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Computer Assited Medical Intervention Tool Kit
 <span id="projectnumber">version 4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classMethod-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Method Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__group__cepmodeling.html">CEP Modeling</a> » <a class="el" href="group__group__cepmodeling__libraries.html">Libraries</a> » <a class="el" href="group__group__cepmodeling__libraries__mml.html">MML</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="classMethod.html" title="A Method represent how to make the boolean assessment with criteria data (a vector of double) ...">Method</a> represent how to make the boolean assessment with criteria data (a vector of double)
<a href="classMethod.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Method_8h_source.html">Method.h</a>></code></p>
<p>Inherited by <a class="el" href="classMinThreshold.html">MinThreshold</a>, <a class="el" href="classThreshold.html">Threshold</a>, and <a class="el" href="classTimePeriodThreshold.html">TimePeriodThreshold</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac2acdb7caba50420beb5316b53debf52"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52">ScopeType</a> { <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a5fd4f721c71f0f0fac33423ad35c3ddf">Any</a>,
<a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6be996cf784c07efa2d475041de0eda2">Average</a>,
<a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a33e528a26df4577a060b01b70663382a">Sum</a>,
<a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6a410c9256e9333166555df5c939ad96">None</a>
}<tr class="memdesc:ac2acdb7caba50420beb5316b53debf52"><td class="mdescLeft"> </td><td class="mdescRight">the scope of the method <a href="classMethod.html#ac2acdb7caba50420beb5316b53debf52">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ac2acdb7caba50420beb5316b53debf52"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a1dffbc0406b85982c641aa11071fadf8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a1dffbc0406b85982c641aa11071fadf8">individualTest</a> (double tested)=0</td></tr>
<tr class="memdesc:a1dffbc0406b85982c641aa11071fadf8"><td class="mdescLeft"> </td><td class="mdescRight">return true if the double passed the test <a href="#a1dffbc0406b85982c641aa11071fadf8">More...</a><br /></td></tr>
<tr class="separator:a1dffbc0406b85982c641aa11071fadf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35b51e68957c08e8bf20ed09f32a06a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a35b51e68957c08e8bf20ed09f32a06a6">Method</a> (mml::Method *m)</td></tr>
<tr class="memdesc:a35b51e68957c08e8bf20ed09f32a06a6"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a35b51e68957c08e8bf20ed09f32a06a6">More...</a><br /></td></tr>
<tr class="separator:a35b51e68957c08e8bf20ed09f32a06a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab886df54c71844441ea35303240fa5dc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#ab886df54c71844441ea35303240fa5dc">scopeTosString</a> ()</td></tr>
<tr class="memdesc:ab886df54c71844441ea35303240fa5dc"><td class="mdescLeft"> </td><td class="mdescRight">get a String of the scope <a href="#ab886df54c71844441ea35303240fa5dc">More...</a><br /></td></tr>
<tr class="separator:ab886df54c71844441ea35303240fa5dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c06d71df398bac16a23b884b2f1e575"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a5c06d71df398bac16a23b884b2f1e575">test</a> (std::vector< double > &values)</td></tr>
<tr class="memdesc:a5c06d71df398bac16a23b884b2f1e575"><td class="mdescLeft"> </td><td class="mdescRight">return true if the vector of fouble values passed the test (see scope) <a href="#a5c06d71df398bac16a23b884b2f1e575">More...</a><br /></td></tr>
<tr class="separator:a5c06d71df398bac16a23b884b2f1e575"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a045505f759c01d9e129792c74f0e0d2b"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a045505f759c01d9e129792c74f0e0d2b">toString</a> ()=0</td></tr>
<tr class="memdesc:a045505f759c01d9e129792c74f0e0d2b"><td class="mdescLeft"> </td><td class="mdescRight">get <a class="el" href="classMethod.html" title="A Method represent how to make the boolean assessment with criteria data (a vector of double) ...">Method</a> name <a href="#a045505f759c01d9e129792c74f0e0d2b">More...</a><br /></td></tr>
<tr class="separator:a045505f759c01d9e129792c74f0e0d2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19c90fc165c63842e7653732fe72507c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a19c90fc165c63842e7653732fe72507c">~Method</a> ()</td></tr>
<tr class="memdesc:a19c90fc165c63842e7653732fe72507c"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a19c90fc165c63842e7653732fe72507c">More...</a><br /></td></tr>
<tr class="separator:a19c90fc165c63842e7653732fe72507c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6fa0488ba51b8c96d1635ac75867f06a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52">ScopeType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMethod.html#a6fa0488ba51b8c96d1635ac75867f06a">scope</a></td></tr>
<tr class="memdesc:a6fa0488ba51b8c96d1635ac75867f06a"><td class="mdescLeft"> </td><td class="mdescRight">scope of the method Any: test is true if all indivitual test are true in the values vector Average: test is true if the indivudal test of values vector's average is true Sum: test is true if the indivudal test of the sum of all double of the values vector is true None: used for monitor wich are not applied to a structural component (ex: time) <a href="#a6fa0488ba51b8c96d1635ac75867f06a">More...</a><br /></td></tr>
<tr class="separator:a6fa0488ba51b8c96d1635ac75867f06a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="classMethod.html" title="A Method represent how to make the boolean assessment with criteria data (a vector of double) ...">Method</a> represent how to make the boolean assessment with criteria data (a vector of double) </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac2acdb7caba50420beb5316b53debf52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2acdb7caba50420beb5316b53debf52">◆ </a></span>ScopeType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52">Method::ScopeType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>the scope of the method </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac2acdb7caba50420beb5316b53debf52a5fd4f721c71f0f0fac33423ad35c3ddf"></a>Any </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac2acdb7caba50420beb5316b53debf52a6be996cf784c07efa2d475041de0eda2"></a>Average </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac2acdb7caba50420beb5316b53debf52a33e528a26df4577a060b01b70663382a"></a>Sum </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac2acdb7caba50420beb5316b53debf52a6a410c9256e9333166555df5c939ad96"></a>None </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a35b51e68957c08e8bf20ed09f32a06a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35b51e68957c08e8bf20ed09f32a06a6">◆ </a></span>Method()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Method::Method </td>
<td>(</td>
<td class="paramtype">mml::Method * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">the</td><td>xsdcxx generated method class </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a19c90fc165c63842e7653732fe72507c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19c90fc165c63842e7653732fe72507c">◆ </a></span>~Method()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Method::~Method </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1dffbc0406b85982c641aa11071fadf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dffbc0406b85982c641aa11071fadf8">◆ </a></span>individualTest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Method::individualTest </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>tested</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return true if the double passed the test </p>
<p>Implemented in <a class="el" href="classThreshold.html#a52c4c38e68ab1f241749182b1bd203a4">Threshold</a>, <a class="el" href="classTimePeriodThreshold.html#a238936d414b22dad953e31577ecfd1fb">TimePeriodThreshold</a>, and <a class="el" href="classMinThreshold.html#a10f2585d905d763497a31d026085ba02">MinThreshold</a>.</p>
</div>
</div>
<a id="ab886df54c71844441ea35303240fa5dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab886df54c71844441ea35303240fa5dc">◆ </a></span>scopeTosString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Method::scopeTosString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get a String of the scope </p>
<p class="reference">References <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a5fd4f721c71f0f0fac33423ad35c3ddf">Any</a>, <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6be996cf784c07efa2d475041de0eda2">Average</a>, <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6a410c9256e9333166555df5c939ad96">None</a>, and <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a33e528a26df4577a060b01b70663382a">Sum</a>.</p>
<p class="reference">Referenced by <a class="el" href="classCriterion.html#a0e610e12153f4bf63016a2fd54309650">Criterion::scopeToString()</a>.</p>
</div>
</div>
<a id="a5c06d71df398bac16a23b884b2f1e575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c06d71df398bac16a23b884b2f1e575">◆ </a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Method::test </td>
<td>(</td>
<td class="paramtype">std::vector< double > & </td>
<td class="paramname"><em>values</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return true if the vector of fouble values passed the test (see scope) </p>
<p class="reference">References <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a5fd4f721c71f0f0fac33423ad35c3ddf">Any</a>, <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6be996cf784c07efa2d475041de0eda2">Average</a>, <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a6a410c9256e9333166555df5c939ad96">None</a>, and <a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52a33e528a26df4577a060b01b70663382a">Sum</a>.</p>
<p class="reference">Referenced by <a class="el" href="classCriterion.html#ab0381c380929c5d284699bb9f5714ec7">Criterion::checkCriterion()</a>.</p>
</div>
</div>
<a id="a045505f759c01d9e129792c74f0e0d2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045505f759c01d9e129792c74f0e0d2b">◆ </a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Method::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get <a class="el" href="classMethod.html" title="A Method represent how to make the boolean assessment with criteria data (a vector of double) ...">Method</a> name </p>
<p>Implemented in <a class="el" href="classThreshold.html#a75b4ed1069daeeabb6152574392bed39">Threshold</a>, <a class="el" href="classTimePeriodThreshold.html#ab5bccc788bfaffeb6fcc15af2487433b">TimePeriodThreshold</a>, and <a class="el" href="classMinThreshold.html#a5ba7b355dd5278275c49eff4eda5d29c">MinThreshold</a>.</p>
<p class="reference">Referenced by <a class="el" href="classCriterion.html#a947178fce38b5dd1ef38659b2f25492e">Criterion::getMethodString()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6fa0488ba51b8c96d1635ac75867f06a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fa0488ba51b8c96d1635ac75867f06a">◆ </a></span>scope</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMethod.html#ac2acdb7caba50420beb5316b53debf52">ScopeType</a> Method::scope</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>scope of the method Any: test is true if all indivitual test are true in the values vector Average: test is true if the indivudal test of values vector's average is true Sum: test is true if the indivudal test of the sum of all double of the values vector is true None: used for monitor wich are not applied to a structural component (ex: time) </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Method_8h_source.html">Method.h</a></li>
<li><a class="el" href="Method_8cpp.html">Method.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|