<!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"/>
<title>GDAL: GDALProxyPoolRasterBand Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>GDALProxyPoolRasterBand Class Reference</h1><!-- doxytag: class="GDALProxyPoolRasterBand" --><!-- doxytag: inherits="GDALProxyRasterBand" --><div class="dynheader">
Inheritance diagram for GDALProxyPoolRasterBand:</div>
<div class="dynsection">
<div class="center">
<img src="classGDALProxyPoolRasterBand.png" usemap="#GDALProxyPoolRasterBand_map" alt=""/>
<map id="GDALProxyPoolRasterBand_map" name="GDALProxyPoolRasterBand_map">
<area href="classGDALProxyRasterBand.html" alt="GDALProxyRasterBand" shape="rect" coords="117,112,341,136"/>
<area href="classGDALRasterBand.html" alt="GDALRasterBand" shape="rect" coords="117,56,341,80"/>
<area href="classGDALMajorObject.html" alt="GDALMajorObject" shape="rect" coords="117,0,341,24"/>
<area href="classGDALProxyPoolMaskBand.html" alt="GDALProxyPoolMaskBand" shape="rect" coords="0,224,224,248"/>
<area href="classGDALProxyPoolOverviewRasterBand.html" alt="GDALProxyPoolOverviewRasterBand" shape="rect" coords="234,224,458,248"/>
</map>
</div>
</div>
<p><a href="classGDALProxyPoolRasterBand-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac71e94cfd2d7a38900b8a2f42ed76e1d"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GDALProxyPoolRasterBand" ref="ac71e94cfd2d7a38900b8a2f42ed76e1d" args="(GDALProxyPoolDataset *poDS, int nBand, GDALDataType eDataType, int nBlockXSize, int nBlockYSize)" -->
</td><td class="memItemRight" valign="bottom"><b>GDALProxyPoolRasterBand</b> (<a class="el" href="classGDALProxyPoolDataset.html">GDALProxyPoolDataset</a> *poDS, int nBand, <a class="el" href="gdal_8h.html#a22e22ce0a55036a96f652765793fb7a4">GDALDataType</a> eDataType, int nBlockXSize, int nBlockYSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12fff595012ac71f6b79d4fc33bdb02b"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GDALProxyPoolRasterBand" ref="a12fff595012ac71f6b79d4fc33bdb02b" args="(GDALProxyPoolDataset *poDS, GDALRasterBand *poUnderlyingRasterBand)" -->
</td><td class="memItemRight" valign="bottom"><b>GDALProxyPoolRasterBand</b> (<a class="el" href="classGDALProxyPoolDataset.html">GDALProxyPoolDataset</a> *poDS, <a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> *poUnderlyingRasterBand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a51cf7df74375fe70e37974a9e1d46f8e">GetMetadata</a> (const char *pszDomain)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a7267a4d6c67f4055a3c7657bf4e650b4">GetMetadataItem</a> (const char *pszName, const char *pszDomain)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a51ac32b204a9ba503ffd66daf6221924">GetCategoryNames</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a14a757ef56f6fcea96ecbb61c587e906">GetUnitType</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classGDALColorTable.html">GDALColorTable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#aff4ca5e0c3c707fe8fd3a724f866f480">GetColorTable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a8584584d13f88344f3a5f19f279917f9">GetOverview</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#aaadaae7339fc1ed837097e76514083fb">GetRasterSampleOverview</a> (int nDesiredSamples)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18ce13948c8ab469f85c172decb2f3b6"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetMaskBand" ref="a18ce13948c8ab469f85c172decb2f3b6" args="()" -->
virtual <a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * </td><td class="memItemRight" valign="bottom"><b>GetMaskBand</b> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ad3729e652d8ed330d90545d8a440b9"></a><!-- doxytag: member="GDALProxyPoolRasterBand::RefUnderlyingRasterBand" ref="a6ad3729e652d8ed330d90545d8a440b9" args="()" -->
virtual <a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * </td><td class="memItemRight" valign="bottom"><b>RefUnderlyingRasterBand</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0204fc328ff96d0805dca562fb7bea82"></a><!-- doxytag: member="GDALProxyPoolRasterBand::UnrefUnderlyingRasterBand" ref="a0204fc328ff96d0805dca562fb7bea82" args="(GDALRasterBand *poUnderlyingRasterBand)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>UnrefUnderlyingRasterBand</b> (<a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> *poUnderlyingRasterBand)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ee60f78e8b4155515fa6e562e718100"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GDALProxyPoolOverviewRasterBand" ref="a7ee60f78e8b4155515fa6e562e718100" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#a7ee60f78e8b4155515fa6e562e718100">GDALProxyPoolOverviewRasterBand</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1dcdb7d6f2e37ee6b070df2e03e5a00"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GDALProxyPoolMaskBand" ref="ac1dcdb7d6f2e37ee6b070df2e03e5a00" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALProxyPoolRasterBand.html#ac1dcdb7d6f2e37ee6b070df2e03e5a00">GDALProxyPoolMaskBand</a></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a51ac32b204a9ba503ffd66daf6221924"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetCategoryNames" ref="a51ac32b204a9ba503ffd66daf6221924" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ** GDALProxyPoolRasterBand::GetCategoryNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch the list of category names for this raster.</p>
<p>The return list is a "StringList" in the sense of the CPL functions. That is a NULL terminated array of strings. Raster values without associated names will have an empty string in the returned list. The first entry in the list is for raster values of zero, and so on.</p>
<p>The returned stringlist should not be altered or freed by the application. It may change on the next GDAL call, so please copy it if it is needed for any period of time.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>list of names, or NULL if none. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#a045ad205134975debf78ca7c7165e1df">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalrasterband_8cpp_source.html#l01428">GDALRasterBand::GetCategoryNames()</a>.</p>
</div>
</div>
<a class="anchor" id="aff4ca5e0c3c707fe8fd3a724f866f480"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetColorTable" ref="aff4ca5e0c3c707fe8fd3a724f866f480" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGDALColorTable.html">GDALColorTable</a> * GDALProxyPoolRasterBand::GetColorTable </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch the color table associated with band.</p>
<p>If there is no associated color table, the return result is NULL. The returned color table remains owned by the <a class="el" href="classGDALRasterBand.html" title="A single raster band (or channel).">GDALRasterBand</a>, and can't be depended on for long, nor should it ever be modified by the caller.</p>
<p>This method is the same as the C function <a class="el" href="gdal_8h.html#ab4ebf9ba142ed1847cfb04143fb75c3e">GDALGetRasterColorTable()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>internal color table, or NULL. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#a0b4dbbe4a47b0c0476d325256de64bd9">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalcolortable_8cpp_source.html#l00230">GDALColorTable::Clone()</a>, and <a class="el" href="gdalrasterband_8cpp_source.html#l01845">GDALRasterBand::GetColorTable()</a>.</p>
</div>
</div>
<a class="anchor" id="a51cf7df74375fe70e37974a9e1d46f8e"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetMetadata" ref="a51cf7df74375fe70e37974a9e1d46f8e" args="(const char *pszDomain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ** GDALProxyPoolRasterBand::GetMetadata </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszDomain</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch metadata.</p>
<p>The returned string list is owned by the object, and may change at any time. It is formated as a "Name=value" list with the last pointer value being NULL. Use the the CPL StringList functions such as CSLFetchNameValue() to manipulate it.</p>
<p>Note that relatively few formats return any metadata at this time.</p>
<p>This method does the same thing as the C function <a class="el" href="gdal_8h.html#a25929a66e99d92c2788485ecf13e2e82">GDALGetMetadata()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pszDomain</em> </td><td>the domain of interest. Use "" or NULL for the default domain.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL or a string list. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#ad189317cd5bfe67eaa78ffcf378aa804">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalmajorobject_8cpp_source.html#l00157">GDALMajorObject::GetMetadata()</a>.</p>
</div>
</div>
<a class="anchor" id="a7267a4d6c67f4055a3c7657bf4e650b4"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetMetadataItem" ref="a7267a4d6c67f4055a3c7657bf4e650b4" args="(const char *pszName, const char *pszDomain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * GDALProxyPoolRasterBand::GetMetadataItem </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszDomain</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch single metadata item.</p>
<p>The C function <a class="el" href="gdal_8h.html#ac24dd49918d985568fa2d97da1080215">GDALGetMetadataItem()</a> does the same thing as this method.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pszName</em> </td><td>the key for the metadata item to fetch. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pszDomain</em> </td><td>the domain to fetch for, use NULL for the default domain.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL on failure to find the key, or a pointer to an internal copy of the value string on success. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#a61614b91ba7e33d4feecdbe5ace1bf07">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalmajorobject_8cpp_source.html#l00241">GDALMajorObject::GetMetadataItem()</a>.</p>
</div>
</div>
<a class="anchor" id="a8584584d13f88344f3a5f19f279917f9"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetOverview" ref="a8584584d13f88344f3a5f19f279917f9" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * GDALProxyPoolRasterBand::GetOverview </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch overview raster band object.</p>
<p>This method is the same as the C function <a class="el" href="gdal_8h.html#a00bba92f9b0c9e56e724ed07aca451b1">GDALGetOverview()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>overview index between 0 and <a class="el" href="classGDALProxyRasterBand.html#a9066af0563b4eb930b32cea7f3f77966">GetOverviewCount()</a>-1.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>overview <a class="el" href="classGDALRasterBand.html" title="A single raster band (or channel).">GDALRasterBand</a>. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#a2d3c04f0aa04b77c64e7e7fb215c4e51">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalrasterband_8cpp_source.html#l02007">GDALRasterBand::GetOverview()</a>.</p>
</div>
</div>
<a class="anchor" id="aaadaae7339fc1ed837097e76514083fb"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetRasterSampleOverview" ref="aaadaae7339fc1ed837097e76514083fb" args="(int nDesiredSamples)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> * GDALProxyPoolRasterBand::GetRasterSampleOverview </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nDesiredSamples</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch best sampling overview.</p>
<p>Returns the most reduced overview of the given band that still satisfies the desired number of samples. This function can be used with zero as the number of desired samples to fetch the most reduced overview. The same band as was passed in will be returned if it has not overviews, or if none of the overviews have enough samples.</p>
<p>This method is the same as the C function GDALGetRasterSampleOverview().</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>nDesiredSamples</em> </td><td>the returned band will have at least this many pixels.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>optimal overview or the band itself. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#ae02ff7eadb7857bc1d6019559e7151ce">GDALProxyRasterBand</a>.</p>
</div>
</div>
<a class="anchor" id="a14a757ef56f6fcea96ecbb61c587e906"></a><!-- doxytag: member="GDALProxyPoolRasterBand::GetUnitType" ref="a14a757ef56f6fcea96ecbb61c587e906" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * GDALProxyPoolRasterBand::GetUnitType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return raster unit type.</p>
<p>Return a name for the units of this raster's values. For instance, it might be "m" for an elevation model in meters, or "ft" for feet. If no units are available, a value of "" will be returned. The returned string should not be modified, nor freed by the calling application.</p>
<p>This method is the same as the C function <a class="el" href="gdal_8h.html#a48e4bb5bb87c2f2df2db3e53badefa75">GDALGetRasterUnitType()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>unit name string. </dd></dl>
<p>Reimplemented from <a class="el" href="classGDALProxyRasterBand.html#a9f7d8c3b066bd2df485d2d5e82b5deb3">GDALProxyRasterBand</a>.</p>
<p>References <a class="el" href="gdalrasterband_8cpp_source.html#l02324">GDALRasterBand::GetUnitType()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gdal__proxy_8h_source.html">gdal_proxy.h</a></li>
<li>gdalproxypool.cpp</li>
</ul>
</div>
<hr>
Generated for GDAL by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.2-20100208.
</body>
</html>
