/usr/share/doc/libbamtools-dev/html/struct_bam_tools_1_1_bam_region.html is in libbamtools-doc 2.4.1+dfsg-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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 | <!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>BamTools: BamTools::BamRegion Struct 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BamTools
 <span id="projectnumber">2.4.1</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_bam_tools.html">BamTools</a></li><li class="navelem"><a class="el" href="struct_bam_tools_1_1_bam_region.html">BamRegion</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="struct_bam_tools_1_1_bam_region-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BamTools::BamRegion Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a sequential genomic region.
<a href="struct_bam_tools_1_1_bam_region.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_bam_aux_8h_source.html">BamAux.h</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:a5b7922dee81342a9b073e9ad3561ce37"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a5b7922dee81342a9b073e9ad3561ce37">BamRegion</a> (const int &leftID=-1, const int &leftPos=-1, const int &rightID=-1, const int &rightPos=-1)</td></tr>
<tr class="memdesc:a5b7922dee81342a9b073e9ad3561ce37"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a5b7922dee81342a9b073e9ad3561ce37">More...</a><br /></td></tr>
<tr class="separator:a5b7922dee81342a9b073e9ad3561ce37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73685728dcf8eadb5192e34932b2a1ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a73685728dcf8eadb5192e34932b2a1ee">BamRegion</a> (const <a class="el" href="struct_bam_tools_1_1_bam_region.html">BamRegion</a> &other)</td></tr>
<tr class="memdesc:a73685728dcf8eadb5192e34932b2a1ee"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#a73685728dcf8eadb5192e34932b2a1ee">More...</a><br /></td></tr>
<tr class="separator:a73685728dcf8eadb5192e34932b2a1ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f94a21e6b0602dedd9aa30b76e44f72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a7f94a21e6b0602dedd9aa30b76e44f72">clear</a> (void)</td></tr>
<tr class="memdesc:a7f94a21e6b0602dedd9aa30b76e44f72"><td class="mdescLeft"> </td><td class="mdescRight">Clears region boundaries. <a href="#a7f94a21e6b0602dedd9aa30b76e44f72">More...</a><br /></td></tr>
<tr class="separator:a7f94a21e6b0602dedd9aa30b76e44f72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47922a2ea611d809a5e84dea65cd8ab8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a47922a2ea611d809a5e84dea65cd8ab8">isLeftBoundSpecified</a> (void) const</td></tr>
<tr class="memdesc:a47922a2ea611d809a5e84dea65cd8ab8"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if region has a left boundary. <a href="#a47922a2ea611d809a5e84dea65cd8ab8">More...</a><br /></td></tr>
<tr class="separator:a47922a2ea611d809a5e84dea65cd8ab8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a379117ba981ba25cb5bd2fbaf9da3aa0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a379117ba981ba25cb5bd2fbaf9da3aa0">isNull</a> (void) const</td></tr>
<tr class="memdesc:a379117ba981ba25cb5bd2fbaf9da3aa0"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if region boundaries are not defined. <a href="#a379117ba981ba25cb5bd2fbaf9da3aa0">More...</a><br /></td></tr>
<tr class="separator:a379117ba981ba25cb5bd2fbaf9da3aa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a478526892e3c9e18f09ce707702b32a8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a478526892e3c9e18f09ce707702b32a8">isRightBoundSpecified</a> (void) const</td></tr>
<tr class="memdesc:a478526892e3c9e18f09ce707702b32a8"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if region has a right boundary. <a href="#a478526892e3c9e18f09ce707702b32a8">More...</a><br /></td></tr>
<tr class="separator:a478526892e3c9e18f09ce707702b32a8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a34bfcf995c20986e3a7442974cba137c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a34bfcf995c20986e3a7442974cba137c">LeftRefID</a></td></tr>
<tr class="memdesc:a34bfcf995c20986e3a7442974cba137c"><td class="mdescLeft"> </td><td class="mdescRight">reference ID for region's left boundary <a href="#a34bfcf995c20986e3a7442974cba137c">More...</a><br /></td></tr>
<tr class="separator:a34bfcf995c20986e3a7442974cba137c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c84513d817b590b74b64399acc178e5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a8c84513d817b590b74b64399acc178e5">LeftPosition</a></td></tr>
<tr class="memdesc:a8c84513d817b590b74b64399acc178e5"><td class="mdescLeft"> </td><td class="mdescRight">position for region's left boundary <a href="#a8c84513d817b590b74b64399acc178e5">More...</a><br /></td></tr>
<tr class="separator:a8c84513d817b590b74b64399acc178e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e11c35bce33870dc0c65019bfe886b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a1e11c35bce33870dc0c65019bfe886b1">RightRefID</a></td></tr>
<tr class="memdesc:a1e11c35bce33870dc0c65019bfe886b1"><td class="mdescLeft"> </td><td class="mdescRight">reference ID for region's right boundary <a href="#a1e11c35bce33870dc0c65019bfe886b1">More...</a><br /></td></tr>
<tr class="separator:a1e11c35bce33870dc0c65019bfe886b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71ce3b72e5e6f74022e21055a3dd3d93"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_bam_region.html#a71ce3b72e5e6f74022e21055a3dd3d93">RightPosition</a></td></tr>
<tr class="memdesc:a71ce3b72e5e6f74022e21055a3dd3d93"><td class="mdescLeft"> </td><td class="mdescRight">position for region's right boundary <a href="#a71ce3b72e5e6f74022e21055a3dd3d93">More...</a><br /></td></tr>
<tr class="separator:a71ce3b72e5e6f74022e21055a3dd3d93"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a sequential genomic region. </p>
<p>Allowed to span multiple (sequential) references.</p>
<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="struct_bam_tools_1_1_bam_region.html" title="Represents a sequential genomic region. ">BamRegion</a> now represents a zero-based, HALF-OPEN interval. In previous versions of <a class="el" href="namespace_bam_tools.html" title="Contains all BamTools classes & methods. ">BamTools</a> (0.x & 1.x) all intervals were treated as zero-based, CLOSED. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5b7922dee81342a9b073e9ad3561ce37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b7922dee81342a9b073e9ad3561ce37">◆ </a></span>BamRegion() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BamTools::BamRegion::BamRegion </td>
<td>(</td>
<td class="paramtype">const int & </td>
<td class="paramname"><em>leftID</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int & </td>
<td class="paramname"><em>leftPos</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int & </td>
<td class="paramname"><em>rightID</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int & </td>
<td class="paramname"><em>rightPos</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor </p>
</div>
</div>
<a id="a73685728dcf8eadb5192e34932b2a1ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73685728dcf8eadb5192e34932b2a1ee">◆ </a></span>BamRegion() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BamTools::BamRegion::BamRegion </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_bam_tools_1_1_bam_region.html">BamRegion</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7f94a21e6b0602dedd9aa30b76e44f72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f94a21e6b0602dedd9aa30b76e44f72">◆ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BamTools::BamRegion::clear </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears region boundaries. </p>
</div>
</div>
<a id="a47922a2ea611d809a5e84dea65cd8ab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47922a2ea611d809a5e84dea65cd8ab8">◆ </a></span>isLeftBoundSpecified()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BamTools::BamRegion::isLeftBoundSpecified </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if region has a left boundary. </p>
</div>
</div>
<a id="a379117ba981ba25cb5bd2fbaf9da3aa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a379117ba981ba25cb5bd2fbaf9da3aa0">◆ </a></span>isNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BamTools::BamRegion::isNull </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if region boundaries are not defined. </p>
</div>
</div>
<a id="a478526892e3c9e18f09ce707702b32a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a478526892e3c9e18f09ce707702b32a8">◆ </a></span>isRightBoundSpecified()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BamTools::BamRegion::isRightBoundSpecified </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if region has a right boundary. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8c84513d817b590b74b64399acc178e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c84513d817b590b74b64399acc178e5">◆ </a></span>LeftPosition</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BamTools::BamRegion::LeftPosition</td>
</tr>
</table>
</div><div class="memdoc">
<p>position for region's left boundary </p>
</div>
</div>
<a id="a34bfcf995c20986e3a7442974cba137c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34bfcf995c20986e3a7442974cba137c">◆ </a></span>LeftRefID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BamTools::BamRegion::LeftRefID</td>
</tr>
</table>
</div><div class="memdoc">
<p>reference ID for region's left boundary </p>
</div>
</div>
<a id="a71ce3b72e5e6f74022e21055a3dd3d93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71ce3b72e5e6f74022e21055a3dd3d93">◆ </a></span>RightPosition</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BamTools::BamRegion::RightPosition</td>
</tr>
</table>
</div><div class="memdoc">
<p>position for region's right boundary </p>
</div>
</div>
<a id="a1e11c35bce33870dc0c65019bfe886b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e11c35bce33870dc0c65019bfe886b1">◆ </a></span>RightRefID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BamTools::BamRegion::RightRefID</td>
</tr>
</table>
</div><div class="memdoc">
<p>reference ID for region's right boundary </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_bam_aux_8h_source.html">BamAux.h</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>
|