<!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: GDALMajorObject 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>GDALMajorObject Class Reference</h1><!-- doxytag: class="GDALMajorObject" -->
<p>Object with metadata.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gdal__priv_8h_source.html">gdal_priv.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for GDALMajorObject:</div>
<div class="dynsection">
<div class="center">
<img src="classGDALMajorObject.png" usemap="#GDALMajorObject_map" alt=""/>
<map id="GDALMajorObject_map" name="GDALMajorObject_map">
<area href="classGDALDataset.html" alt="GDALDataset" shape="rect" coords="0,56,186,80"/>
<area href="classGDALDriver.html" alt="GDALDriver" shape="rect" coords="392,56,578,80"/>
<area href="classGDALDriverManager.html" alt="GDALDriverManager" shape="rect" coords="588,56,774,80"/>
<area href="classGDALRasterBand.html" alt="GDALRasterBand" shape="rect" coords="784,56,970,80"/>
<area href="classGDALPamDataset.html" alt="GDALPamDataset" shape="rect" coords="196,112,382,136"/>
<area href="classGDALProxyDataset.html" alt="GDALProxyDataset" shape="rect" coords="196,168,382,192"/>
<area href="classVRTDataset.html" alt="VRTDataset" shape="rect" coords="196,224,382,248"/>
<area href="classVRTDriver.html" alt="VRTDriver" shape="rect" coords="392,112,578,136"/>
<area href="classGDALAllValidMaskBand.html" alt="GDALAllValidMaskBand" shape="rect" coords="980,112,1166,136"/>
<area href="classGDALNoDataMaskBand.html" alt="GDALNoDataMaskBand" shape="rect" coords="980,168,1166,192"/>
<area href="classGDALNoDataValuesMaskBand.html" alt="GDALNoDataValuesMaskBand" shape="rect" coords="980,224,1166,248"/>
<area href="classGDALPamRasterBand.html" alt="GDALPamRasterBand" shape="rect" coords="980,280,1166,304"/>
<area href="classGDALProxyRasterBand.html" alt="GDALProxyRasterBand" shape="rect" coords="980,336,1166,360"/>
<area href="classVRTRasterBand.html" alt="VRTRasterBand" shape="rect" coords="980,392,1166,416"/>
</map>
</div>
</div>
<p><a href="classGDALMajorObject-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="a09c3ab3e9227c2e090702a8cb64ff766"></a><!-- doxytag: member="GDALMajorObject::GetMOFlags" ref="a09c3ab3e9227c2e090702a8cb64ff766" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>GetMOFlags</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa53480c392557784a40a0b8c333834d1"></a><!-- doxytag: member="GDALMajorObject::SetMOFlags" ref="aa53480c392557784a40a0b8c333834d1" args="(int nFlags)" -->
void </td><td class="memItemRight" valign="bottom"><b>SetMOFlags</b> (int nFlags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALMajorObject.html#acd684ae534858b97b25723a1e2934048">GetDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALMajorObject.html#af334bc8d152f130a55783ea36938735b">SetDescription</a> (const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classGDALMajorObject.html#a8ce3bf5795bbebfe9bc643e2152bb360">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="classGDALMajorObject.html#a61ab7226d95b20e3e1f42461a1f62906">SetMetadata</a> (char **papszMetadata, 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="classGDALMajorObject.html#ad17f496c8b6d0c0be6f52437d3ba8a6d">GetMetadataItem</a> (const char *pszName, 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="classGDALMajorObject.html#a3e157735f6ff6e11935c2a2dbcc24c92">SetMetadataItem</a> (const char *pszName, const char *pszValue, const char *pszDomain="")</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addb1d9dcdbb76b133e4ebceb01f66cf7"></a><!-- doxytag: member="GDALMajorObject::nFlags" ref="addb1d9dcdbb76b133e4ebceb01f66cf7" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>nFlags</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6b530938d33269b31d2b73977d9b2c9"></a><!-- doxytag: member="GDALMajorObject::sDescription" ref="ab6b530938d33269b31d2b73977d9b2c9" args="" -->
<a class="el" href="classCPLString.html">CPLString</a> </td><td class="memItemRight" valign="bottom"><b>sDescription</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7d5c5dd3f612bfcbf7b7ce13129e001"></a><!-- doxytag: member="GDALMajorObject::oMDMD" ref="af7d5c5dd3f612bfcbf7b7ce13129e001" args="" -->
<a class="el" href="classGDALMultiDomainMetadata.html">GDALMultiDomainMetadata</a> </td><td class="memItemRight" valign="bottom"><b>oMDMD</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Object with metadata. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acd684ae534858b97b25723a1e2934048"></a><!-- doxytag: member="GDALMajorObject::GetDescription" ref="acd684ae534858b97b25723a1e2934048" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * GDALMajorObject::GetDescription </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch object description.</p>
<p>The semantics of the returned description are specific to the derived type. For GDALDatasets it is the dataset name. For GDALRasterBands it is actually a description (if supported) or "".</p>
<p>This method is the same as the C function <a class="el" href="gdal_8h.html#acf7272f513f436a95572116ca9fb8885">GDALGetDescription()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to internal description string. </dd></dl>
<p>Referenced by <a class="el" href="gdaldriver_8cpp_source.html#l00111">GDALDriver::Create()</a>, <a class="el" href="gdaldriver_8cpp_source.html#l00603">GDALDriver::CreateCopy()</a>, <a class="el" href="vrtdataset_8cpp_source.html#l00106">VRTDataset::FlushCache()</a>, <a class="el" href="gdaldataset_8cpp_source.html#l01981">GDALOpen()</a>, <a class="el" href="gdaldataset_8cpp_source.html#l02071">GDALOpenShared()</a>, <a class="el" href="gdaldrivermanager_8cpp_source.html#l00413">GDALDriverManager::GetDriverByName()</a>, <a class="el" href="gdaldataset_8cpp_source.html#l01856">GDALDataset::GetFileList()</a>, <a class="el" href="gdalrasterband_8cpp_source.html#l01169">GDALRasterBand::GetLockedBlockRef()</a>, <a class="el" href="gdaldataset_8cpp_source.html#l01057">GDALDataset::MarkAsShared()</a>, <a class="el" href="gdaldrivermanager_8cpp_source.html#l00284">GDALDriverManager::RegisterDriver()</a>, <a class="el" href="gdaldataset_8cpp_source.html#l00222">GDALDataset::~GDALDataset()</a>, and <a class="el" href="gdalrasterband_8cpp_source.html#l00084">GDALRasterBand::~GDALRasterBand()</a>.</p>
</div>
</div>
<a class="anchor" id="a8ce3bf5795bbebfe9bc643e2152bb360"></a><!-- doxytag: member="GDALMajorObject::GetMetadata" ref="a8ce3bf5795bbebfe9bc643e2152bb360" args="(const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ** GDALMajorObject::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 in <a class="el" href="classGDALProxyDataset.html#a7cc444c22a051be7d22734562e1a9601">GDALProxyDataset</a>, <a class="el" href="classGDALProxyRasterBand.html#ad189317cd5bfe67eaa78ffcf378aa804">GDALProxyRasterBand</a>, <a class="el" href="classGDALProxyPoolDataset.html#adc2bc0077e769f7c2cf984a11c130396">GDALProxyPoolDataset</a>, <a class="el" href="classGDALProxyPoolRasterBand.html#a51cf7df74375fe70e37974a9e1d46f8e">GDALProxyPoolRasterBand</a>, <a class="el" href="classVRTSourcedRasterBand.html#a58fa2ce34b13c90f0d5824a693214330">VRTSourcedRasterBand</a>, and <a class="el" href="classVRTDriver.html#a77103ea13fa276f3af017f0521645ed8">VRTDriver</a>.</p>
<p>Referenced by <a class="el" href="gdalproxypool_8cpp_source.html#l00875">GDALProxyPoolRasterBand::GetMetadata()</a>, and <a class="el" href="gdalproxypool_8cpp_source.html#l00617">GDALProxyPoolDataset::GetMetadata()</a>.</p>
</div>
</div>
<a class="anchor" id="ad17f496c8b6d0c0be6f52437d3ba8a6d"></a><!-- doxytag: member="GDALMajorObject::GetMetadataItem" ref="ad17f496c8b6d0c0be6f52437d3ba8a6d" args="(const char *pszName, const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * GDALMajorObject::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> = <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>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 in <a class="el" href="classGDALProxyDataset.html#adfa2746d3ae9bbe17b1ecbb44ee0124a">GDALProxyDataset</a>, <a class="el" href="classGDALProxyRasterBand.html#a61614b91ba7e33d4feecdbe5ace1bf07">GDALProxyRasterBand</a>, <a class="el" href="classGDALProxyPoolDataset.html#ac3d4057a09a816372cf3b6ef8ac4f34d">GDALProxyPoolDataset</a>, and <a class="el" href="classGDALProxyPoolRasterBand.html#a7267a4d6c67f4055a3c7657bf4e650b4">GDALProxyPoolRasterBand</a>.</p>
<p>Referenced by <a class="el" href="rasterio_8cpp_source.html#l01864">GDALDatasetCopyWholeRaster()</a>, <a class="el" href="overview_8cpp_source.html#l00850">GDALRegenerateOverviews()</a>, <a class="el" href="gdalrasterband_8cpp_source.html#l01606">GDALRasterBand::GetMaximum()</a>, <a class="el" href="gdalproxypool_8cpp_source.html#l00902">GDALProxyPoolRasterBand::GetMetadataItem()</a>, <a class="el" href="gdalproxypool_8cpp_source.html#l00644">GDALProxyPoolDataset::GetMetadataItem()</a>, <a class="el" href="gdalrasterband_8cpp_source.html#l01689">GDALRasterBand::GetMinimum()</a>, and <a class="el" href="gdalrasterband_8cpp_source.html#l03154">GDALRasterBand::GetStatistics()</a>.</p>
</div>
</div>
<a class="anchor" id="af334bc8d152f130a55783ea36938735b"></a><!-- doxytag: member="GDALMajorObject::SetDescription" ref="af334bc8d152f130a55783ea36938735b" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GDALMajorObject::SetDescription </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszNewDesc</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set object description.</p>
<p>The semantics of the description are specific to the derived type. For GDALDatasets it is the dataset name. For GDALRasterBands it is actually a description (if supported) or "".</p>
<p>Normally application code should not set the "description" for GDALDatasets. It is handled internally.</p>
<p>This method is the same as the C function <a class="el" href="gdal_8h.html#a19c2fc1f303eec4df98fc2d9c5acd9cb">GDALSetDescription()</a>. </p>
<p>Referenced by <a class="el" href="gdaldriver_8cpp_source.html#l00111">GDALDriver::Create()</a>, <a class="el" href="gdaldriver_8cpp_source.html#l00603">GDALDriver::CreateCopy()</a>, and <a class="el" href="gdaldataset_8cpp_source.html#l01981">GDALOpen()</a>.</p>
</div>
</div>
<a class="anchor" id="a61ab7226d95b20e3e1f42461a1f62906"></a><!-- doxytag: member="GDALMajorObject::SetMetadata" ref="a61ab7226d95b20e3e1f42461a1f62906" args="(char **papszMetadata, const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPLErr GDALMajorObject::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 in <a class="el" href="classGDALPamDataset.html#a42f3cc6eea3a4fbaf962e4221ed7b721">GDALPamDataset</a>, <a class="el" href="classGDALPamRasterBand.html#af86b2ba06aca0fb761c1bf8c234f9a8c">GDALPamRasterBand</a>, <a class="el" href="classGDALProxyDataset.html#a7bd8b356051a402ce00d6b63bcc7608c">GDALProxyDataset</a>, <a class="el" href="classGDALProxyRasterBand.html#a291b53f4239d8a061a05427b12d7923f">GDALProxyRasterBand</a>, <a class="el" href="classVRTDataset.html#ab40527beb0504a9a326d56bdec10599f">VRTDataset</a>, <a class="el" href="classVRTRasterBand.html#a126340ce65c05ba0b700574e4dc52b44">VRTRasterBand</a>, <a class="el" href="classVRTSourcedRasterBand.html#a8b3181cc9dfba70389e0cf1f2dccf9b2">VRTSourcedRasterBand</a>, and <a class="el" href="classVRTDriver.html#a126dd5c93f813badfd66b99f7165c5e4">VRTDriver</a>.</p>
</div>
</div>
<a class="anchor" id="a3e157735f6ff6e11935c2a2dbcc24c92"></a><!-- doxytag: member="GDALMajorObject::SetMetadataItem" ref="a3e157735f6ff6e11935c2a2dbcc24c92" args="(const char *pszName, const char *pszValue, const char *pszDomain="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPLErr GDALMajorObject::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 in <a class="el" href="classGDALPamDataset.html#ae454b4eb0bc10db1b70fb71afe0d48ac">GDALPamDataset</a>, <a class="el" href="classGDALPamRasterBand.html#a91c4f35ba6159b13057c9e0b4aad86fb">GDALPamRasterBand</a>, <a class="el" href="classGDALProxyDataset.html#a8cbf9253b6c8b1defba29c6d7850bcc4">GDALProxyDataset</a>, <a class="el" href="classGDALProxyRasterBand.html#aec79c76cd8465becfe9319c57dd80f8c">GDALProxyRasterBand</a>, <a class="el" href="classVRTDataset.html#aa32453b40f3d4ba8cffe5088c70df818">VRTDataset</a>, <a class="el" href="classVRTRasterBand.html#aba308992abf0d829f9ef508cc820d72c">VRTRasterBand</a>, and <a class="el" href="classVRTSourcedRasterBand.html#affea8fd62ff7ac87acf278020b114b30">VRTSourcedRasterBand</a>.</p>
<p>Referenced by <a class="el" href="gdaldrivermanager_8cpp_source.html#l00284">GDALDriverManager::RegisterDriver()</a>, and <a class="el" href="gdalrasterband_8cpp_source.html#l03640">GDALRasterBand::SetStatistics()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gdal__priv_8h_source.html">gdal_priv.h</a></li>
<li>gdalmajorobject.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>
