<!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: VRTSourcedRasterBand 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>VRTSourcedRasterBand Class Reference</h1><!-- doxytag: class="VRTSourcedRasterBand" --><!-- doxytag: inherits="VRTRasterBand" --><div class="dynheader">
Inheritance diagram for VRTSourcedRasterBand:</div>
<div class="dynsection">
<div class="center">
<img src="classVRTSourcedRasterBand.png" usemap="#VRTSourcedRasterBand_map" alt=""/>
<map id="VRTSourcedRasterBand_map" name="VRTSourcedRasterBand_map">
<area href="classVRTRasterBand.html" alt="VRTRasterBand" shape="rect" coords="0,112,149,136"/>
<area href="classGDALRasterBand.html" alt="GDALRasterBand" shape="rect" coords="0,56,149,80"/>
<area href="classGDALMajorObject.html" alt="GDALMajorObject" shape="rect" coords="0,0,149,24"/>
<area href="classVRTDerivedRasterBand.html" alt="VRTDerivedRasterBand" shape="rect" coords="0,224,149,248"/>
</map>
</div>
</div>
<p><a href="classVRTSourcedRasterBand-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="a2789b3b84f36576eac7d183a9afa8409"></a><!-- doxytag: member="VRTSourcedRasterBand::VRTSourcedRasterBand" ref="a2789b3b84f36576eac7d183a9afa8409" args="(GDALDataset *poDS, int nBand)" -->
</td><td class="memItemRight" valign="bottom"><b>VRTSourcedRasterBand</b> (<a class="el" href="classGDALDataset.html">GDALDataset</a> *poDS, int nBand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0be307bb245a1e48db49f61920e43ea"></a><!-- doxytag: member="VRTSourcedRasterBand::VRTSourcedRasterBand" ref="ab0be307bb245a1e48db49f61920e43ea" args="(GDALDataType eType, int nXSize, int nYSize)" -->
</td><td class="memItemRight" valign="bottom"><b>VRTSourcedRasterBand</b> (<a class="el" href="gdal_8h.html#a22e22ce0a55036a96f652765793fb7a4">GDALDataType</a> eType, int nXSize, int nYSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2439be758c158517656dfacbeafe6878"></a><!-- doxytag: member="VRTSourcedRasterBand::VRTSourcedRasterBand" ref="a2439be758c158517656dfacbeafe6878" args="(GDALDataset *poDS, int nBand, GDALDataType eType, int nXSize, int nYSize)" -->
</td><td class="memItemRight" valign="bottom"><b>VRTSourcedRasterBand</b> (<a class="el" href="classGDALDataset.html">GDALDataset</a> *poDS, int nBand, <a class="el" href="gdal_8h.html#a22e22ce0a55036a96f652765793fb7a4">GDALDataType</a> eType, int nXSize, int nYSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3447268530a371629f9baaa4bf0acdea"></a><!-- doxytag: member="VRTSourcedRasterBand::IRasterIO" ref="a3447268530a371629f9baaa4bf0acdea" args="(GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int)" -->
virtual CPLErr </td><td class="memItemRight" valign="bottom"><b>IRasterIO</b> (<a class="el" href="gdal_8h.html#ae602fdf251b6b0210a5af5a7cf7623b3">GDALRWFlag</a>, int, int, int, int, void *, int, int, <a class="el" href="gdal_8h.html#a22e22ce0a55036a96f652765793fb7a4">GDALDataType</a>, int, int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classVRTSourcedRasterBand.html#a58fa2ce34b13c90f0d5824a693214330">GetMetadata</a> (const char *pszDomain="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual CPLErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classVRTSourcedRasterBand.html#a8b3181cc9dfba70389e0cf1f2dccf9b2">SetMetadata</a> (char **papszMetadata, const char *pszDomain="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual CPLErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classVRTSourcedRasterBand.html#affea8fd62ff7ac87acf278020b114b30">SetMetadataItem</a> (const char *pszName, const char *pszValue, const char *pszDomain="")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a474c6e33be7f9956b1bd678e35fe31a0"></a><!-- doxytag: member="VRTSourcedRasterBand::XMLInit" ref="a474c6e33be7f9956b1bd678e35fe31a0" args="(CPLXMLNode *, const char *)" -->
virtual CPLErr </td><td class="memItemRight" valign="bottom"><b>XMLInit</b> (<a class="el" href="structCPLXMLNode.html">CPLXMLNode</a> *, const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a086639b4c5a55a0bc8624f79b5fa051e"></a><!-- doxytag: member="VRTSourcedRasterBand::SerializeToXML" ref="a086639b4c5a55a0bc8624f79b5fa051e" args="(const char *pszVRTPath)" -->
virtual <a class="el" href="structCPLXMLNode.html">CPLXMLNode</a> * </td><td class="memItemRight" valign="bottom"><b>SerializeToXML</b> (const char *pszVRTPath)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4153ca8d5e90c8ec65fe995eb150477b"></a><!-- doxytag: member="VRTSourcedRasterBand::AddSource" ref="a4153ca8d5e90c8ec65fe995eb150477b" args="(VRTSource *)" -->
CPLErr </td><td class="memItemRight" valign="bottom"><b>AddSource</b> (<a class="el" href="classVRTSource.html">VRTSource</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af03c546ec9fa7c3d0628b5c4ee73113e"></a><!-- doxytag: member="VRTSourcedRasterBand::AddSimpleSource" ref="af03c546ec9fa7c3d0628b5c4ee73113e" args="(GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, const char *pszResampling="near", double dfNoDataValue=VRT_NODATA_UNSET)" -->
CPLErr </td><td class="memItemRight" valign="bottom"><b>AddSimpleSource</b> (<a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, const char *pszResampling="near", double dfNoDataValue=VRT_NODATA_UNSET)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0a520ac7d04ca1da2a48ffb4f7a6e8a"></a><!-- doxytag: member="VRTSourcedRasterBand::AddComplexSource" ref="aa0a520ac7d04ca1da2a48ffb4f7a6e8a" args="(GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, double dfScaleOff=0.0, double dfScaleRatio=1.0, double dfNoDataValue=VRT_NODATA_UNSET, int nColorTableComponent=0)" -->
CPLErr </td><td class="memItemRight" valign="bottom"><b>AddComplexSource</b> (<a class="el" href="classGDALRasterBand.html">GDALRasterBand</a> *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, double dfScaleOff=0.0, double dfScaleRatio=1.0, double dfNoDataValue=VRT_NODATA_UNSET, int nColorTableComponent=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9182360a070ce451db6e8dc80b692f54"></a><!-- doxytag: member="VRTSourcedRasterBand::AddFuncSource" ref="a9182360a070ce451db6e8dc80b692f54" args="(VRTImageReadFunc pfnReadFunc, void *hCBData, double dfNoDataValue=VRT_NODATA_UNSET)" -->
CPLErr </td><td class="memItemRight" valign="bottom"><b>AddFuncSource</b> (VRTImageReadFunc pfnReadFunc, void *hCBData, double dfNoDataValue=VRT_NODATA_UNSET)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadca5d0021960d4c01fa695fbca3f3e9"></a><!-- doxytag: member="VRTSourcedRasterBand::IReadBlock" ref="aadca5d0021960d4c01fa695fbca3f3e9" args="(int, int, void *)" -->
virtual CPLErr </td><td class="memItemRight" valign="bottom"><b>IReadBlock</b> (int, int, void *)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ecd05166426fa6d24def0791b47e556"></a><!-- doxytag: member="VRTSourcedRasterBand::nSources" ref="a5ecd05166426fa6d24def0791b47e556" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>nSources</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a306728b97aff94ec707c13ea4e64768c"></a><!-- doxytag: member="VRTSourcedRasterBand::papoSources" ref="a306728b97aff94ec707c13ea4e64768c" args="" -->
<a class="el" href="classVRTSource.html">VRTSource</a> ** </td><td class="memItemRight" valign="bottom"><b>papoSources</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9397f793884f019010c01a86dc6ee30"></a><!-- doxytag: member="VRTSourcedRasterBand::bEqualAreas" ref="af9397f793884f019010c01a86dc6ee30" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>bEqualAreas</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a58fa2ce34b13c90f0d5824a693214330"></a><!-- doxytag: member="VRTSourcedRasterBand::GetMetadata" ref="a58fa2ce34b13c90f0d5824a693214330" args="(const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ** VRTSourcedRasterBand::GetMetadata </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszDomain</em> = <code>""</code></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="classGDALMajorObject.html#a8ce3bf5795bbebfe9bc643e2152bb360">GDALMajorObject</a>.</p>
</div>
</div>
<a class="anchor" id="a8b3181cc9dfba70389e0cf1f2dccf9b2"></a><!-- doxytag: member="VRTSourcedRasterBand::SetMetadata" ref="a8b3181cc9dfba70389e0cf1f2dccf9b2" args="(char **papszMetadata, const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPLErr VRTSourcedRasterBand::SetMetadata </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>papszMetadataIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszDomain</em> = <code>""</code></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>Set metadata.</p>
<p>The C function <a class="el" href="gdal_8h.html#ac92aec63371e9e4b0121276406f0bd8d">GDALSetMetadata()</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>papszMetadata</em> </td><td>the metadata in name=value string list format to apply. </td></tr>
<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>CE_None on success, CE_Failure on failure and CE_Warning if the metadata has been accepted, but is likely not maintained persistently by the underlying object between sessions. </dd></dl>
<p>Reimplemented from <a class="el" href="classVRTRasterBand.html#a126340ce65c05ba0b700574e4dc52b44">VRTRasterBand</a>.</p>
<p>References <a class="el" href="gdaldrivermanager_8cpp_source.html#l00437">GDALGetDriverByName()</a>.</p>
</div>
</div>
<a class="anchor" id="affea8fd62ff7ac87acf278020b114b30"></a><!-- doxytag: member="VRTSourcedRasterBand::SetMetadataItem" ref="affea8fd62ff7ac87acf278020b114b30" args="(const char *pszName, const char *pszValue, const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPLErr VRTSourcedRasterBand::SetMetadataItem </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>pszValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszDomain</em> = <code>""</code></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>Set single metadata item.</p>
<p>The C function <a class="el" href="gdal_8h.html#a55f0b4c5192d18deb4dcf1a89ed59bbe">GDALSetMetadataItem()</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>pszValue</em> </td><td>the value to assign to the key. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pszDomain</em> </td><td>the domain to set within, use NULL for the default domain.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CE_None on success, or an error code on failure. </dd></dl>
<p>Reimplemented from <a class="el" href="classVRTRasterBand.html#aba308992abf0d829f9ef508cc820d72c">VRTRasterBand</a>.</p>
<p>References <a class="el" href="gdaldrivermanager_8cpp_source.html#l00437">GDALGetDriverByName()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="vrtdataset_8h_source.html">vrtdataset.h</a></li>
<li>vrtsourcedrasterband.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>
