-
Notifications
You must be signed in to change notification settings - Fork 0
/
MemoryMap_8h_source.html
157 lines (155 loc) · 14 KB
/
MemoryMap_8h_source.html
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
<!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.5"/>
<title>isce3: isce/cxx/isce3/io/gdal/detail/MemoryMap.h Source File</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 style="padding-left: 0.5em;">
<div id="projectname">isce3
 <span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="sphinx/html/index.html"><span>Python classes</span></a></li>
<li><a href="https://github-fn.jpl.nasa.gov/isce-3/isce/issues/"><span>Issue Tracker</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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="dir_404e96cc334514cbeb4d3a6830fc20a4.html">isce</a></li><li class="navelem"><a class="el" href="dir_242328b4dda42afcab822a3a2c9e5d23.html">cxx</a></li><li class="navelem"><a class="el" href="dir_25ad1bde3345b7504bdf331e9ef506fd.html">isce3</a></li><li class="navelem"><a class="el" href="dir_c9afef05fb8bf72552370ddadbf67a02.html">io</a></li><li class="navelem"><a class="el" href="dir_382ab63cfda24c1fe356e3b49d19f706.html">gdal</a></li><li class="navelem"><a class="el" href="dir_89478537c9fcc06659ad3c653bb98150.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">MemoryMap.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <cpl_virtualmem.h></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <gdal_priv.h></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../forward.h"</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span>isce3 { <span class="keyword">namespace </span>io { <span class="keyword">namespace </span>gdal { <span class="keyword">namespace </span>detail {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html"> 11</a></span> <span class="keyword">class </span><a class="code" href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html">MemoryMap</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <a class="code" href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html">MemoryMap</a>() : _mmap(<span class="keyword">nullptr</span>, [](CPLVirtualMem *) {}) {}</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _mmap.get(); }</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// Get pointer to start of virtual memory mapping</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">void</span> * data() { <span class="keywordflow">return</span> CPLVirtualMemGetAddr(_mmap.get()); }</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// Get pointer to start of virtual memory mapping</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">const</span> <span class="keywordtype">void</span> * data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> CPLVirtualMemGetAddr(_mmap.get()); }</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">// Size in bytes of mapped region</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  std::size_t size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> CPLVirtualMemGetSize(_mmap.get()); }</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// Access mode</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  CPLVirtualMemAccessMode access()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> CPLVirtualMemGetAccessMode(_mmap.get()); }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// Stride in bytes between the start of adjacent columns</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  std::size_t colstride()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _colstride; }</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Stride in bytes between the start of adjacent rows</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::size_t rowstride()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _rowstride; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classisce3_1_1io_1_1gdal_1_1Raster.html">isce3::io::gdal::Raster</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html">MemoryMap</a>(<span class="keyword">const</span> GDALRasterBand * raster);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html">MemoryMap</a>(GDALRasterBand * raster, GDALAccess <a class="code" href="classisce3_1_1io_1_1gdal_1_1Raster.html#a404b652e647c80bd6261be301d6387df">access</a>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::shared_ptr<CPLVirtualMem> _mmap;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::size_t _colstride = 0;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  std::size_t _rowstride = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> };</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> }}}}</div>
<div class="ttc" id="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap_html"><div class="ttname"><a href="classisce3_1_1io_1_1gdal_1_1detail_1_1MemoryMap.html">isce3::io::gdal::detail::MemoryMap</a></div><div class="ttdef"><b>Definition:</b> MemoryMap.h:11</div></div>
<div class="ttc" id="classisce3_1_1io_1_1gdal_1_1Raster_html"><div class="ttname"><a href="classisce3_1_1io_1_1gdal_1_1Raster.html">isce3::io::gdal::Raster</a></div><div class="ttdoc">Wrapper for GDALRasterBand representing a single raster. </div><div class="ttdef"><b>Definition:</b> Raster.h:14</div></div>
<div class="ttc" id="classisce3_1_1io_1_1gdal_1_1Raster_html_a404b652e647c80bd6261be301d6387df"><div class="ttname"><a href="classisce3_1_1io_1_1gdal_1_1Raster.html#a404b652e647c80bd6261be301d6387df">isce3::io::gdal::Raster::access</a></div><div class="ttdeci">GDALAccess access() const </div><div class="ttdoc">Access mode. </div><div class="ttdef"><b>Definition:</b> Raster.h:146</div></div>
</div><!-- fragment --></div><!-- contents -->
<hr>
Generated for ISCE3.0 by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.5.
</body>
</html>