GDAL
|
Object with metadata. More...
#include <gdal_priv.h>
Public Member Functions | |
int | GetMOFlags () |
void | SetMOFlags (int nFlags) |
virtual const char * | GetDescription () const |
Fetch object description. More... | |
virtual void | SetDescription (const char *) |
Set object description. More... | |
virtual char ** | GetMetadataDomainList () |
Fetch list of metadata domains. More... | |
virtual char ** | GetMetadata (const char *pszDomain="") |
Fetch metadata. More... | |
virtual CPLErr | SetMetadata (char **papszMetadata, const char *pszDomain="") |
Set metadata. More... | |
virtual const char * | GetMetadataItem (const char *pszName, const char *pszDomain="") |
Fetch single metadata item. More... | |
virtual CPLErr | SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="") |
Set single metadata item. More... | |
Protected Member Functions | |
char ** | BuildMetadataDomainList (char **papszList, int bCheckNonEmpty,...) CPL_NULL_TERMINATED |
Helper function for custom implementations of GetMetadataDomainList() More... | |
Protected Attributes | |
int | nFlags |
CPLString | sDescription |
GDALMultiDomainMetadata | oMDMD |
Object with metadata.
|
protected |
Helper function for custom implementations of GetMetadataDomainList()
papszList | initial list of domains. May be NULL. Will become invalid after function call (use return value) |
bCheckNonEmpty | if TRUE, each candidate domain will be tested to be non empty |
... | NULL terminated variadic list of candidate domains. |
|
virtual |
Fetch object description.
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 "".
This method is the same as the C function GDALGetDescription().
|
virtual |
Fetch metadata.
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.
Note that relatively few formats return any metadata at this time.
This method does the same thing as the C function GDALGetMetadata().
pszDomain | the domain of interest. Use "" or NULL for the default domain. |
Reimplemented in VRTDriver, VRTSourcedRasterBand, GDALProxyPoolRasterBand, GDALProxyPoolDataset, GDALPamDataset, GDALProxyRasterBand, and GDALProxyDataset.
|
virtual |
Fetch list of metadata domains.
The returned string list is the list of (non-empty) metadata domains.
This method does the same thing as the C function GDALGetMetadataDomainList().
Reimplemented in VRTDriver, VRTSourcedRasterBand, GDALProxyRasterBand, and GDALProxyDataset.
|
virtual |
Fetch single metadata item.
The C function GDALGetMetadataItem() does the same thing as this method.
pszName | the key for the metadata item to fetch. |
pszDomain | the domain to fetch for, use NULL for the default domain. |
Reimplemented in VRTSourcedRasterBand, GDALProxyPoolRasterBand, GDALProxyPoolDataset, GDALPamDataset, GDALProxyRasterBand, and GDALProxyDataset.
|
virtual |
Set object description.
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 "".
Normally application code should not set the "description" for GDALDatasets. It is handled internally.
This method is the same as the C function GDALSetDescription().
Reimplemented in VRTRasterBand, and GDALPamRasterBand.
|
virtual |
Set metadata.
The C function GDALSetMetadata() does the same thing as this method.
papszMetadataIn | the metadata in name=value string list format to apply. |
pszDomain | the domain of interest. Use "" or NULL for the default domain. |
Reimplemented in VRTDriver, VRTSourcedRasterBand, VRTRasterBand, GDALPamRasterBand, VRTDataset, GDALPamDataset, GDALProxyRasterBand, and GDALProxyDataset.
|
virtual |
Set single metadata item.
The C function GDALSetMetadataItem() does the same thing as this method.
pszName | the key for the metadata item to fetch. |
pszValue | the value to assign to the key. |
pszDomain | the domain to set within, use NULL for the default domain. |
Reimplemented in VRTSourcedRasterBand, VRTRasterBand, GDALPamRasterBand, VRTDataset, GDALPamDataset, GDALProxyRasterBand, and GDALProxyDataset.